From d150cd71b62386aba719409bda748a2f3d3802fb Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 13 Oct 2026 19:34:31 +0000 Subject: [PATCH 1/3] ## Python SDK Changes: * `open_router.guardrails.list()`: `response.data[].allow_safety_retention_google` **Added** * `open_router.guardrails.create()`: * `request.allow_safety_retention_google` **Added** * `response.data.allow_safety_retention_google` **Added** * `open_router.guardrails.get()`: `response.data.allow_safety_retention_google` **Added** * `open_router.guardrails.update()`: * `request.allow_safety_retention_google` **Added** * `response.data.allow_safety_retention_google` **Added** --- .speakeasy/gen.lock | 78 ++--- .speakeasy/gen.yaml | 2 +- .speakeasy/out.openapi.yaml | 22 +- .speakeasy/workflow.lock | 10 +- RELEASES.md | 12 +- docs/components/aabenchmarkentry.mdx | 6 +- docs/components/activityitem.mdx | 26 +- docs/components/activityresponse.mdx | 2 +- docs/components/additionaltoolsitem.mdx | 8 +- docs/components/additionaltoolsitemtool.mdx | 4 +- .../additionaltoolsitemtoolfunction.mdx | 18 +- docs/components/advisorreasoning.mdx | 4 +- docs/components/advisorservertoolconfig.mdx | 16 +- .../advisorservertoolopenrouter.mdx | 4 +- docs/components/agent.mdx | 4 +- docs/components/agentmessageitem.mdx | 14 +- .../agentmessageitemcontentinputimage.mdx | 8 +- docs/components/alignment.mdx | 2 +- .../components/alignmentallowedcallrecord.mdx | 6 +- .../components/alignmentblockedcallrecord.mdx | 6 +- docs/components/alignmentchataudio.mdx | 4 +- docs/components/alignmentchatimage.mdx | 4 +- .../components/alignmentchatimageimageurl.mdx | 2 +- docs/components/alignmentchatrejected.mdx | 12 +- docs/components/alignmentchattoolcall.mdx | 6 +- .../alignmentchattoolcallfunction.mdx | 4 +- docs/components/alignmentplugin.mdx | 12 +- docs/components/alignmentrulerecord.mdx | 4 +- .../alignmentunavailablecallrecord.mdx | 6 +- docs/components/allowedtools.mdx | 4 +- docs/components/always.mdx | 2 +- docs/components/annotationaddedevent.mdx | 14 +- docs/components/annotationfile.mdx | 4 +- docs/components/annotationurlcitation.mdx | 4 +- .../annotationwebsearchcitation.mdx | 4 +- .../anthropicadvisormessageusageiteration.mdx | 14 +- .../components/anthropicadvisortoolresult.mdx | 6 +- .../components/anthropicbase64imagesource.mdx | 6 +- docs/components/anthropicbase64pdfsource.mdx | 6 +- .../anthropicbashcodeexecutionoutput.mdx | 4 +- .../anthropicbashcodeexecutionresult.mdx | 10 +- .../anthropicbashcodeexecutiontoolresult.mdx | 6 +- ...hropicbashcodeexecutiontoolresulterror.mdx | 4 +- .../anthropiccachecontroldirective.mdx | 4 +- docs/components/anthropiccachecreation.mdx | 4 +- .../anthropiccitationcharlocation.mdx | 14 +- .../anthropiccitationcharlocationparam.mdx | 12 +- .../anthropiccitationcontentblocklocation.mdx | 14 +- ...ropiccitationcontentblocklocationparam.mdx | 12 +- .../anthropiccitationpagelocation.mdx | 14 +- .../anthropiccitationpagelocationparam.mdx | 12 +- docs/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 +- docs/components/anthropiccompactionblock.mdx | 6 +- .../anthropiccompactionusageiteration.mdx | 12 +- docs/components/anthropiccontainer.mdx | 6 +- docs/components/anthropiccontainerskill.mdx | 6 +- docs/components/anthropiccontainerupload.mdx | 4 +- docs/components/anthropicdirectcaller.mdx | 2 +- docs/components/anthropicdocumentblock.mdx | 8 +- .../anthropicdocumentblockparam.mdx | 12 +- .../anthropicdocumentblockparamcitations.mdx | 2 +- .../anthropicencryptedcodeexecutionresult.mdx | 10 +- docs/components/anthropicfile.mdx | 16 +- docs/components/anthropicfiledeleted.mdx | 6 +- .../anthropicfiledocumentsource.mdx | 4 +- docs/components/anthropicfilelist.mdx | 10 +- docs/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 +- docs/components/anthropicplaintextsource.mdx | 6 +- .../anthropicredactedthinkingblock.mdx | 4 +- .../anthropicrefusalstopdetails.mdx | 6 +- docs/components/anthropicsafeguard.mdx | 6 +- .../anthropicsearchresultblockparam.mdx | 12 +- ...thropicsearchresultblockparamcitations.mdx | 2 +- docs/components/anthropicservertoolusage.mdx | 4 +- docs/components/anthropictextblock.mdx | 6 +- docs/components/anthropictextblockparam.mdx | 8 +- ...pictexteditorcodeexecutioncreateresult.mdx | 4 +- ...exteditorcodeexecutionstrreplaceresult.mdx | 12 +- ...ropictexteditorcodeexecutiontoolresult.mdx | 6 +- ...texteditorcodeexecutiontoolresulterror.mdx | 6 +- ...ropictexteditorcodeexecutionviewresult.mdx | 12 +- docs/components/anthropicthinkingblock.mdx | 6 +- .../anthropicthinkingblockbinding.mdx | 4 +- docs/components/anthropicthinkingturns.mdx | 4 +- docs/components/anthropictoolreference.mdx | 4 +- docs/components/anthropictoolsearchresult.mdx | 4 +- .../anthropictoolsearchresulterror.mdx | 6 +- .../anthropictoolsearchtoolbm25.mdx | 12 +- .../anthropictoolsearchtoolregex.mdx | 12 +- .../anthropictoolsearchtoolresult.mdx | 6 +- docs/components/anthropictooluseblock.mdx | 10 +- docs/components/anthropictooluseskeep.mdx | 4 +- docs/components/anthropictoolusestrigger.mdx | 4 +- .../anthropicunknownusageiteration.mdx | 12 +- docs/components/anthropicurlimagesource.mdx | 4 +- docs/components/anthropicurlpdfsource.mdx | 4 +- docs/components/anthropicwebfetchblock.mdx | 8 +- .../anthropicwebfetchtoolresult.mdx | 8 +- .../anthropicwebfetchtoolresulterror.mdx | 4 +- docs/components/anthropicwebsearchresult.mdx | 10 +- .../anthropicwebsearchresultblockparam.mdx | 10 +- .../anthropicwebsearchtoolresult.mdx | 8 +- .../anthropicwebsearchtoolresulterror.mdx | 4 +- .../anthropicwebsearchtooluserlocation.mdx | 10 +- docs/components/applypatchcallitem.mdx | 10 +- .../applypatchcalloperationdiffdeltaevent.mdx | 10 +- .../applypatchcalloperationdiffdoneevent.mdx | 10 +- docs/components/applypatchcalloutputitem.mdx | 10 +- .../applypatchcreatefileoperation.mdx | 6 +- .../applypatchdeletefileoperation.mdx | 4 +- docs/components/applypatchservertool.mdx | 2 +- .../components/applypatchservertoolconfig.mdx | 2 +- .../applypatchservertoolopenrouter.mdx | 4 +- .../applypatchupdatefileoperation.mdx | 6 +- docs/components/apprankingsitem.mdx | 10 +- docs/components/apprankingsresponse.mdx | 4 +- docs/components/architecture.mdx | 10 +- docs/components/audiourl.mdx | 2 +- docs/components/autobetarouterplugin.mdx | 12 +- docs/components/autorouterplugin.mdx | 14 +- .../badgatewayresponseerrordata.mdx | 6 +- .../badrequestresponseerrordata.mdx | 6 +- docs/components/baseinputsmessage.mdx | 8 +- docs/components/basereasoningconfig.mdx | 8 +- docs/components/bashservertool.mdx | 4 +- docs/components/bashservertoolconfig.mdx | 4 +- docs/components/batchdeletedobject.mdx | 6 +- docs/components/batchdeletiontargets.mdx | 4 +- docs/components/batcherrorresponseerror.mdx | 4 +- docs/components/batchlistitem.mdx | 24 +- .../batchlistitemcompletiontokensdetails.mdx | 6 +- docs/components/batchlistitemerror.mdx | 2 +- .../batchlistitemprompttokensdetails.mdx | 10 +- .../components/batchlistitemrequestcounts.mdx | 6 +- .../components/batchlistitemservertooluse.mdx | 6 +- docs/components/batchlistitemusage.mdx | 26 +- docs/components/batchlistresponse.mdx | 10 +- docs/components/batchobject.mdx | 24 +- .../batchobjectcompletiontokensdetails.mdx | 6 +- docs/components/batchobjectdata.mdx | 6 +- docs/components/batchobjectdebug.mdx | 6 +- docs/components/batchobjecterror.mdx | 2 +- docs/components/batchobjectfile.mdx | 6 +- docs/components/batchobjectfunction.mdx | 4 +- docs/components/batchobjectimageurl.mdx | 2 +- .../batchobjectprompttokensdetails.mdx | 10 +- docs/components/batchobjectrequestcounts.mdx | 6 +- docs/components/batchobjectresponse.mdx | 6 +- docs/components/batchobjectservertooluse.mdx | 6 +- .../batchobjectservertoolusedetails.mdx | 6 +- docs/components/batchobjecttimings.mdx | 6 +- docs/components/batchobjecturlcitation.mdx | 10 +- docs/components/batchobjectusage.mdx | 26 +- ...equiredresponsecompletiontokensdetails.mdx | 6 +- .../batchpaymentrequiredresponseerror.mdx | 4 +- ...entrequiredresponseprompttokensdetails.mdx | 10 +- ...chpaymentrequiredresponserequestcounts.mdx | 6 +- ...chpaymentrequiredresponseservertooluse.mdx | 6 +- .../batchpaymentrequiredresponseusage.mdx | 26 +- docs/components/batchproviderpreferences.mdx | 4 +- docs/components/batchsubmitbody.mdx | 10 +- docs/components/bodychatcompletion.mdx | 24 +- .../bodycompletiontokensdetails.mdx | 6 +- docs/components/bodylist.mdx | 10 +- docs/components/bodymessage.mdx | 22 +- docs/components/bodyprompttokensdetails1.mdx | 10 +- docs/components/bodyprompttokensdetails2.mdx | 10 +- docs/components/bodyservertooluse.mdx | 6 +- docs/components/bodyusage1.mdx | 14 +- docs/components/bodyusage2.mdx | 22 +- docs/components/bodyusage3.mdx | 12 +- docs/components/booleancapability.mdx | 2 +- .../bulkaddworkspacemembersrequest.mdx | 2 +- .../bulkaddworkspacemembersresponse.mdx | 4 +- docs/components/bulkassignkeysrequest.mdx | 2 +- docs/components/bulkassignkeysresponse.mdx | 2 +- docs/components/bulkassignmembersrequest.mdx | 2 +- docs/components/bulkassignmembersresponse.mdx | 2 +- .../bulkremoveworkspacemembersrequest.mdx | 2 +- .../bulkremoveworkspacemembersresponse.mdx | 2 +- docs/components/bulkunassignkeysrequest.mdx | 2 +- docs/components/bulkunassignkeysresponse.mdx | 2 +- .../components/bulkunassignmembersrequest.mdx | 2 +- .../bulkunassignmembersresponse.mdx | 2 +- docs/components/byokkey.mdx | 32 +- docs/components/chatassistantimages.mdx | 2 +- .../chatassistantimagesimageurl.mdx | 2 +- docs/components/chatassistantmessage.mdx | 20 +- docs/components/chataudiooutput.mdx | 8 +- docs/components/chatchoice.mdx | 8 +- docs/components/chatcontentaudio.mdx | 4 +- .../components/chatcontentaudioinputaudio.mdx | 4 +- docs/components/chatcontentcachecontrol.mdx | 4 +- docs/components/chatcontentfile.mdx | 4 +- docs/components/chatcontentfilefile.mdx | 6 +- docs/components/chatcontentimage.mdx | 4 +- docs/components/chatcontentimageimageurl.mdx | 4 +- docs/components/chatcontenttext.mdx | 8 +- docs/components/chatcontentvideo.mdx | 4 +- docs/components/chatcontentvideoinput.mdx | 4 +- docs/components/chatdebugoptions.mdx | 2 +- docs/components/chatdevelopermessage.mdx | 8 +- ...hatdevelopermessageconfigurationupdate.mdx | 2 +- docs/components/chatdynamicservertool.mdx | 4 +- docs/components/chatformatgrammarconfig.mdx | 4 +- .../components/chatformatjsonobjectconfig.mdx | 2 +- .../components/chatformatjsonschemaconfig.mdx | 4 +- docs/components/chatformatpythonconfig.mdx | 2 +- docs/components/chatformattextconfig.mdx | 2 +- docs/components/chatfunctiontoolfunction.mdx | 8 +- .../chatfunctiontoolfunctionfunction.mdx | 10 +- docs/components/chatjsonschemaconfig.mdx | 8 +- docs/components/chatnamedtoolchoice.mdx | 4 +- .../chatnamedtoolchoicefunction.mdx | 2 +- docs/components/chatrequest.mdx | 84 ++--- docs/components/chatrequestreasoning.mdx | 4 +- docs/components/chatresult.mdx | 18 +- .../components/chatsearchmodelsservertool.mdx | 4 +- docs/components/chatservertoolchoice.mdx | 2 +- docs/components/chatstreamchoice.mdx | 8 +- docs/components/chatstreamchunk.mdx | 20 +- docs/components/chatstreamchunkerror.mdx | 6 +- docs/components/chatstreamchunkmetadata.mdx | 4 +- docs/components/chatstreamdelta.mdx | 14 +- docs/components/chatstreamingresponse.mdx | 2 +- docs/components/chatstreamoptions.mdx | 2 +- docs/components/chatstreamtoolcall.mdx | 8 +- .../components/chatstreamtoolcallfunction.mdx | 4 +- docs/components/chatsystemmessage.mdx | 8 +- .../chatsystemmessageconfigurationupdate.mdx | 2 +- docs/components/chattokenlogprob.mdx | 8 +- docs/components/chattokenlogprobs.mdx | 4 +- .../components/chattokenlogprobtoplogprob.mdx | 6 +- docs/components/chattoolcall.mdx | 6 +- docs/components/chattoolcallfunction.mdx | 4 +- docs/components/chattoolmessage.mdx | 6 +- docs/components/chatusage.mdx | 18 +- .../chatusagecompletiontokensdetails.mdx | 8 +- .../chatusageprompttokensdetails.mdx | 8 +- docs/components/chatusermessage.mdx | 6 +- docs/components/chatwebsearchshorthand.mdx | 26 +- docs/components/choice.mdx | 10 +- .../codeinterpretercallcodedeltaevent.mdx | 10 +- .../codeinterpretercallcodedoneevent.mdx | 10 +- .../codeinterpretercallcompletedevent.mdx | 8 +- .../codeinterpretercallinprogressevent.mdx | 8 +- .../codeinterpretercallinterpretingevent.mdx | 8 +- docs/components/codeinterpreterfileoutput.mdx | 20 +- .../components/codeinterpreterimageoutput.mdx | 4 +- docs/components/codeinterpreterlogsoutput.mdx | 4 +- docs/components/codeinterpreterservertool.mdx | 4 +- docs/components/codexlocalshelltool.mdx | 2 +- docs/components/compactionitem.mdx | 8 +- docs/components/compoundfilter.mdx | 4 +- docs/components/computeruseservertool.mdx | 8 +- docs/components/configurationupdateitem.mdx | 6 +- .../configurationupdatereasoning.mdx | 2 +- docs/components/conflictresponseerrordata.mdx | 6 +- docs/components/containerauto.mdx | 6 +- docs/components/containerautoenvironment.mdx | 6 +- docs/components/containerfile.mdx | 14 +- docs/components/containerfilelistresponse.mdx | 10 +- .../containernetworkpolicyallowlist.mdx | 4 +- .../containernetworkpolicydisabled.mdx | 2 +- .../containerreferenceenvironment.mdx | 8 +- docs/components/contentcompaction.mdx | 8 +- docs/components/contentencryptedcontent.mdx | 6 +- docs/components/contentfilterbuiltinentry.mdx | 8 +- .../contentfilterbuiltinentryinput.mdx | 8 +- docs/components/contentfilterentry.mdx | 6 +- docs/components/contentimageurl.mdx | 4 +- docs/components/contentimageurlimageurl.mdx | 2 +- docs/components/contentpartaddedevent.mdx | 12 +- docs/components/contentpartaudio.mdx | 4 +- docs/components/contentpartdoneevent.mdx | 12 +- docs/components/contentpartimage.mdx | 4 +- docs/components/contentpartimageimageurl.mdx | 2 +- docs/components/contentpartinputaudio.mdx | 4 +- docs/components/contentpartinputfile.mdx | 4 +- docs/components/contentpartinputvideo.mdx | 4 +- docs/components/contentpartvideo.mdx | 4 +- docs/components/contentredactedthinking.mdx | 4 +- docs/components/contentservertooluse.mdx | 10 +- docs/components/contenttext.mdx | 4 +- docs/components/contentthinking.mdx | 6 +- docs/components/contenttoolreference.mdx | 4 +- docs/components/contenttoolresult.mdx | 10 +- docs/components/contenttooluse.mdx | 10 +- docs/components/contenttoplogprob.mdx | 6 +- .../components/contentwebsearchtoolresult.mdx | 8 +- .../contentwebsearchtoolresulterror.mdx | 4 +- docs/components/contextcompactionitem.mdx | 8 +- docs/components/contextcompressionplugin.mdx | 6 +- docs/components/contextmanagement.mdx | 2 +- docs/components/contradiction.mdx | 4 +- docs/components/costdetails.mdx | 8 +- docs/components/createbyokkeyrequest.mdx | 26 +- docs/components/createbyokkeyresponse.mdx | 2 +- docs/components/createenduserrequest.mdx | 2 +- docs/components/createguardrailrequest.mdx | 45 +-- docs/components/createguardrailresponse.mdx | 2 +- docs/components/createinternrequest.mdx | 12 +- .../createobservabilitydestinationrequest.mdx | 28 +- ...createobservabilitydestinationresponse.mdx | 2 +- .../createpresetfrominferenceresponse.mdx | 2 +- .../createprivateendpointrequest.mdx | 16 +- ...teendpointvalidationfailedresponsedata.mdx | 4 +- ...eendpointvalidationfailedresponseerror.mdx | 4 +- .../createscimgroupmappingrequest.mdx | 6 +- .../createscimgroupmappingresponse.mdx | 2 +- docs/components/createscimsyncjobresponse.mdx | 2 +- docs/components/createworkspacerequest.mdx | 24 +- docs/components/createworkspaceresponse.mdx | 2 +- docs/components/customtool.mdx | 12 +- .../customtoolcallinputdeltaevent.mdx | 10 +- .../customtoolcallinputdoneevent.mdx | 10 +- docs/components/customtoolcallitem.mdx | 16 +- docs/components/customtoolcalloutputitem.mdx | 8 +- ...stomtoolcalloutputitemoutputinputimage.mdx | 8 +- docs/components/dabenchmarkentry.mdx | 10 +- docs/components/datetimeservertool.mdx | 4 +- docs/components/datetimeservertoolconfig.mdx | 2 +- docs/components/debugevent.mdx | 6 +- docs/components/debugeventdebug.mdx | 4 +- docs/components/debugeventtimings.mdx | 6 +- docs/components/decisions.mdx | 6 +- docs/components/decisionschoiceanswer.mdx | 8 +- docs/components/decisionschoicequestion.mdx | 6 +- docs/components/decisionsnoulanswer.mdx | 4 +- docs/components/decisionsnoulquestion.mdx | 6 +- .../decisionsnoulquestioncriteria.mdx | 4 +- docs/components/decisionsrequest.mdx | 14 +- docs/components/decisionsresponse.mdx | 10 +- docs/components/decisionsresponseusage.mdx | 6 +- docs/components/decisionsscoreanswer.mdx | 10 +- docs/components/decisionsscorequestion.mdx | 6 +- docs/components/defaultparameters.mdx | 12 +- docs/components/deferredbm25search.mdx | 4 +- docs/components/deferredcustomsearch.mdx | 8 +- docs/components/deferredregexsearch.mdx | 4 +- docs/components/deferredtoolscontrol.mdx | 8 +- docs/components/deletebyokkeyresponse.mdx | 2 +- docs/components/deleteguardrailresponse.mdx | 2 +- docs/components/deleteinternrequest.mdx | 2 +- docs/components/deleteinternresponse.mdx | 2 +- ...deleteobservabilitydestinationresponse.mdx | 2 +- .../deleteprivateendpointresponse.mdx | 2 +- .../deleteprivateendpointresponsedata.mdx | 2 +- .../deletescimgroupmappingresponse.mdx | 2 +- .../deleteworkspacebudgetresponse.mdx | 2 +- docs/components/deleteworkspaceresponse.mdx | 2 +- docs/components/easyinputmessage.mdx | 8 +- .../easyinputmessagecontentinputimage.mdx | 8 +- .../edgenetworktimeoutresponseerrordata.mdx | 6 +- docs/components/editclearthinking20251015.mdx | 4 +- docs/components/editcleartooluses20250919.mdx | 12 +- docs/components/editcompact20260112.mdx | 8 +- docs/components/embeddings.mdx | 6 +- docs/components/endpointinfo.mdx | 6 +- docs/components/endpointsmetadata.mdx | 4 +- docs/components/enduser.mdx | 8 +- docs/components/enduserresponse.mdx | 2 +- docs/components/enumcapability.mdx | 4 +- docs/components/errorevent.mdx | 10 +- docs/components/failedmodel.mdx | 6 +- docs/components/filecitation.mdx | 8 +- docs/components/fileparserplugin.mdx | 6 +- docs/components/filepath.mdx | 6 +- docs/components/filesearchservertool.mdx | 10 +- docs/components/filesservertool.mdx | 4 +- docs/components/filters.mdx | 6 +- .../components/forbiddenresponseerrordata.mdx | 6 +- docs/components/formatgrammar.mdx | 6 +- docs/components/formatjsonobjectconfig.mdx | 2 +- docs/components/formatjsonschemaconfig.mdx | 10 +- docs/components/formattext.mdx | 2 +- docs/components/formattextconfig.mdx | 2 +- docs/components/frameimage.mdx | 6 +- docs/components/frameimageimageurl.mdx | 2 +- docs/components/freemodeldailyrequests.mdx | 6 +- .../components/functioncallargsdeltaevent.mdx | 10 +- docs/components/functioncallargsdoneevent.mdx | 12 +- docs/components/functioncallitem.mdx | 20 +- .../functioncallitemsubagentitem.mdx | 4 +- docs/components/functioncalloutputitem.mdx | 10 +- ...functioncalloutputitemoutputinputimage.mdx | 8 +- docs/components/fusionanalysisresult.mdx | 10 +- .../fusioncallanalysiscompletedevent.mdx | 10 +- .../fusioncallanalysisinprogressevent.mdx | 12 +- docs/components/fusioncallcompletedevent.mdx | 8 +- docs/components/fusioncallinprogressevent.mdx | 8 +- docs/components/fusioncallpaneladdedevent.mdx | 10 +- .../fusioncallpanelcompletedevent.mdx | 12 +- docs/components/fusioncallpaneldeltaevent.mdx | 12 +- .../components/fusioncallpanelfailedevent.mdx | 14 +- .../fusioncallpanelreasoningdeltaevent.mdx | 12 +- docs/components/fusionplugin.mdx | 14 +- docs/components/fusionplugintool.mdx | 4 +- docs/components/fusionservertoolconfig.mdx | 16 +- .../fusionservertoolconfigreasoning.mdx | 4 +- .../components/fusionservertoolconfigtool.mdx | 4 +- .../components/fusionservertoolopenrouter.mdx | 4 +- docs/components/fusionsource.mdx | 4 +- .../gatewaytimeoutresponseerrordata.mdx | 6 +- docs/components/generationcontentdata.mdx | 6 +- .../generationcontentdataoutput.mdx | 4 +- docs/components/generationcontenterror.mdx | 10 +- .../generationcontenterrorattempt.mdx | 8 +- docs/components/generationcontentresponse.mdx | 2 +- docs/components/generationresponse.mdx | 2 +- docs/components/generationresponsedata.mdx | 90 +++--- docs/components/getbyokkeyresponse.mdx | 2 +- docs/components/getguardrailresponse.mdx | 2 +- .../getobservabilitydestinationresponse.mdx | 2 +- docs/components/getpresetresponse.mdx | 2 +- docs/components/getpresetversionresponse.mdx | 2 +- .../getscimgroupmappingresponse.mdx | 2 +- docs/components/getscimsyncjobresponse.mdx | 2 +- docs/components/gettoolresponse.mdx | 2 +- .../components/getworkspacebudgetresponse.mdx | 4 +- docs/components/getworkspaceresponse.mdx | 2 +- docs/components/goneresponseerrordata.mdx | 6 +- docs/components/guardrail.mdx | 51 +-- docs/components/image.mdx | 4 +- docs/components/imageendpoint.mdx | 14 +- .../components/imagegencallcompletedevent.mdx | 8 +- .../imagegencallgeneratingevent.mdx | 8 +- .../imagegencallinprogressevent.mdx | 8 +- .../imagegencallpartialimageevent.mdx | 12 +- docs/components/imagegencompletedevent.mdx | 10 +- docs/components/imagegeneration.mdx | 6 +- .../imagegenerationproviderpreferences.mdx | 12 +- ...gegenerationproviderpreferencesoptions.mdx | 292 ++++++++--------- docs/components/imagegenerationrequest.mdx | 34 +- docs/components/imagegenerationresponse.mdx | 6 +- .../imagegenerationresponsedata.mdx | 4 +- docs/components/imagegenerationservertool.mdx | 22 +- .../imagegenerationservertoolconfig.mdx | 4 +- .../imagegenerationservertoolopenrouter.mdx | 4 +- docs/components/imagegenerationusage.mdx | 26 +- ...generationusagecompletiontokensdetails.mdx | 6 +- ...magegenerationusageprompttokensdetails.mdx | 10 +- .../imagegenerationusageservertooluse.mdx | 6 +- docs/components/imagegenpartialimageevent.mdx | 6 +- docs/components/imagegenstreamerrorevent.mdx | 4 +- .../imagegenstreamerroreventerror.mdx | 8 +- docs/components/imagegentextchunkevent.mdx | 6 +- docs/components/imagemodelarchitecture.mdx | 4 +- .../imagemodelendpointsresponse.mdx | 4 +- docs/components/imagemodellistitem.mdx | 16 +- docs/components/imagemodelslistresponse.mdx | 2 +- docs/components/imagepricingentry.mdx | 8 +- docs/components/imagestreamingresponse.mdx | 2 +- docs/components/incompletedetails.mdx | 2 +- docs/components/input1.mdx | 2 +- docs/components/input2.mdx | 2 +- docs/components/inputaudio.mdx | 4 +- docs/components/inputaudioinputaudio.mdx | 4 +- docs/components/inputfile.mdx | 10 +- docs/components/inputimage.mdx | 8 +- docs/components/inputimagemask.mdx | 4 +- docs/components/inputmessageitem.mdx | 8 +- .../inputmessageitemcontentinputimage.mdx | 8 +- docs/components/inputschema.mdx | 8 +- docs/components/inputsmessage.mdx | 12 +- docs/components/inputsreasoning.mdx | 16 +- docs/components/inputtext.mdx | 6 +- docs/components/inputtokensdetails.mdx | 4 +- docs/components/inputvideo.mdx | 6 +- docs/components/intern.mdx | 28 +- .../internalserverresponseerrordata.mdx | 6 +- .../components/internchatassistantmessage.mdx | 6 +- docs/components/internchatchoice.mdx | 6 +- docs/components/internchatcompletionchunk.mdx | 16 +- .../internchatcompletionrequest.mdx | 10 +- docs/components/internchatdelta.mdx | 8 +- .../components/internchatdevelopermessage.mdx | 4 +- docs/components/internchatechoedtoolcall.mdx | 4 +- .../internchatechoedtoolcallfunction.mdx | 4 +- docs/components/internchaterror.mdx | 6 +- docs/components/internchaterrormetadata.mdx | 4 +- .../internchatprompttokensdetails.mdx | 2 +- docs/components/internchatsteeredresponse.mdx | 4 +- docs/components/internchatstreamerror.mdx | 6 +- .../internchatstreamingresponse.mdx | 2 +- docs/components/internchatsystemmessage.mdx | 4 +- docs/components/internchattextpart.mdx | 4 +- docs/components/internchattoolcall.mdx | 8 +- .../components/internchattoolcallfunction.mdx | 4 +- docs/components/internchattoolmessage.mdx | 6 +- docs/components/internchatusage.mdx | 10 +- docs/components/internchatusermessage.mdx | 4 +- docs/components/interndaemonaccess.mdx | 4 +- .../interninvokeacceptedresponse.mdx | 4 +- docs/components/interninvokerequest.mdx | 4 +- docs/components/internlifecycleerrorerror.mdx | 6 +- .../internlifecycleerrormetadata.mdx | 4 +- docs/components/internlistresponse.mdx | 6 +- docs/components/itemreferenceitem.mdx | 4 +- docs/components/jevrouterplugin.mdx | 10 +- docs/components/keepall.mdx | 2 +- docs/components/key.mdx | 14 +- docs/components/keyassignment.mdx | 14 +- docs/components/keybudget.mdx | 18 +- docs/components/legacychatcontentvideo.mdx | 6 +- .../legacychatcontentvideoinput.mdx | 4 +- docs/components/legacywebsearchservertool.mdx | 18 +- docs/components/listbyokkeysresponse.mdx | 4 +- docs/components/listendpointsresponse.mdx | 12 +- docs/components/listendusersresponse.mdx | 4 +- docs/components/listguardrailsresponse.mdx | 4 +- .../components/listkeyassignmentsresponse.mdx | 4 +- .../listmemberassignmentsresponse.mdx | 4 +- .../listobservabilitydestinationsresponse.mdx | 4 +- docs/components/listpresetsresponse.mdx | 4 +- .../components/listpresetversionsresponse.mdx | 4 +- .../listprivateendpointsresponse.mdx | 2 +- .../listscimgroupmappingsresponse.mdx | 4 +- docs/components/listscimgroupsresponse.mdx | 4 +- docs/components/listtoolsresponse.mdx | 6 +- docs/components/listtoolsresponselinks.mdx | 2 +- .../listworkspacebudgetsresponse.mdx | 4 +- .../listworkspacemembersresponse.mdx | 4 +- docs/components/listworkspacesresponse.mdx | 4 +- docs/components/localshellcallitem.mdx | 10 +- docs/components/localshellcallitemaction.mdx | 12 +- docs/components/localshellcalloutputitem.mdx | 8 +- docs/components/logprob.mdx | 8 +- docs/components/logprobs.mdx | 4 +- docs/components/logprobscontent.mdx | 8 +- docs/components/managedprivateendpoint.mdx | 18 +- .../managedprivateendpointresponse.mdx | 2 +- docs/components/match.mdx | 6 +- docs/components/maxprice.mdx | 10 +- docs/components/mcpapprovalrequestitem.mdx | 10 +- docs/components/mcpapprovalresponseitem.mdx | 10 +- docs/components/mcpcallitem.mdx | 14 +- docs/components/mcphttperror.mdx | 6 +- docs/components/mcplisttoolsitem.mdx | 10 +- docs/components/mcplisttoolsitemtool.mdx | 8 +- docs/components/mcpprotocolerror.mdx | 6 +- docs/components/mcpservertool.mdx | 18 +- docs/components/mcptoolexecutionerror.mdx | 4 +- docs/components/memberassignment.mdx | 12 +- docs/components/message.mdx | 16 +- .../messagesadvisortoolresultblock.mdx | 6 +- .../messagesbashtoolresultblock.mdx | 10 +- .../messagesbashtoolresultblockfile.mdx | 12 +- docs/components/messagesfallbackparam.mdx | 4 +- docs/components/messagesmessageparam.mdx | 8 +- docs/components/messagesoutputconfig.mdx | 6 +- .../components/messagesoutputconfigformat.mdx | 4 +- docs/components/messagesrequest.mdx | 56 ++-- docs/components/messagesrequestmetadata.mdx | 2 +- docs/components/messagesrequesttool.mdx | 4 +- .../messagessearchmodelsservertool.mdx | 4 +- .../messagesshelltoolresultblock.mdx | 10 +- .../messagesshelltoolresultblockfile.mdx | 12 +- docs/components/messagestooladditionblock.mdx | 6 +- ...stooladditionblocktoolmcptoolreference.mdx | 6 +- ...oladditionblocktoolmcptoolsetreference.mdx | 4 +- ...agestooladditionblocktooltoolreference.mdx | 4 +- docs/components/messagestoolremovalblock.mdx | 6 +- ...estoolremovalblocktoolmcptoolreference.mdx | 6 +- ...oolremovalblocktoolmcptoolsetreference.mdx | 4 +- ...sagestoolremovalblocktooltoolreference.mdx | 4 +- docs/components/mismatchbehavior.mdx | 2 +- docs/components/model.mdx | 40 +-- docs/components/modelaliastarget.mdx | 4 +- docs/components/modelarchitecture.mdx | 10 +- docs/components/modelbenchmarks.mdx | 4 +- docs/components/modellinks.mdx | 2 +- docs/components/modelreasoning.mdx | 10 +- docs/components/modelresponse.mdx | 2 +- docs/components/modelscountresponse.mdx | 2 +- docs/components/modelscountresponsedata.mdx | 2 +- docs/components/modelslistresponse.mdx | 6 +- docs/components/modelslistresponselinks.mdx | 2 +- docs/components/moderationplugin.mdx | 2 +- docs/components/multimodalmedia.mdx | 4 +- docs/components/namespacefunctiontool.mdx | 18 +- docs/components/namespacetool.mdx | 8 +- docs/components/nativesupport.mdx | 6 +- docs/components/nativetools.mdx | 2 +- docs/components/never.mdx | 2 +- docs/components/notfoundresponseerrordata.mdx | 6 +- docs/components/oauthjwks.mdx | 2 +- .../observabilityarizedestination.mdx | 34 +- .../observabilityarizedestinationconfig.mdx | 10 +- .../observabilitybraintrustdestination.mdx | 34 +- ...servabilitybraintrustdestinationconfig.mdx | 8 +- .../observabilityclickhousedestination.mdx | 34 +- ...servabilityclickhousedestinationconfig.mdx | 14 +- .../observabilitydatadogdestination.mdx | 34 +- .../observabilitydatadogdestinationconfig.mdx | 8 +- .../observabilityfilterrulegroup.mdx | 4 +- .../observabilityfilterrulesconfig.mdx | 4 +- ...observabilityfilterrulesconfignullable.mdx | 4 +- .../observabilitygrafanadestination.mdx | 34 +- .../observabilitygrafanadestinationconfig.mdx | 8 +- .../observabilitylangfusedestination.mdx | 34 +- ...observabilitylangfusedestinationconfig.mdx | 8 +- .../observabilitylangsmithdestination.mdx | 34 +- ...bservabilitylangsmithdestinationconfig.mdx | 10 +- .../observabilitynewrelicdestination.mdx | 34 +- ...observabilitynewrelicdestinationconfig.mdx | 6 +- .../observabilityopikdestination.mdx | 34 +- .../observabilityopikdestinationconfig.mdx | 8 +- .../observabilityotelcollectordestination.mdx | 34 +- ...vabilityotelcollectordestinationconfig.mdx | 4 +- .../observabilityposthogdestination.mdx | 34 +- .../observabilityposthogdestinationconfig.mdx | 6 +- .../observabilityrampdestination.mdx | 34 +- .../observabilityrampdestinationconfig.mdx | 6 +- .../components/observabilitys3destination.mdx | 34 +- .../observabilitys3destinationconfig.mdx | 18 +- .../observabilitysentrydestination.mdx | 34 +- .../observabilitysentrydestinationconfig.mdx | 6 +- .../observabilitysnowflakedestination.mdx | 34 +- ...bservabilitysnowflakedestinationconfig.mdx | 16 +- .../observabilityweavedestination.mdx | 34 +- .../observabilityweavedestinationconfig.mdx | 10 +- .../observabilitywebhookdestination.mdx | 34 +- .../observabilitywebhookdestinationconfig.mdx | 6 +- docs/components/openaifile.mdx | 16 +- docs/components/openaifiledeleted.mdx | 8 +- docs/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 +- docs/components/openairesponsestoolchoice.mdx | 2 +- .../openairesponsestoolchoiceapplypatch.mdx | 2 +- .../openairesponsestoolchoicefunction.mdx | 4 +- .../openairesponsestoolchoiceshell.mdx | 2 +- docs/components/openresponsescreatedevent.mdx | 6 +- docs/components/openresponseserrorfield.mdx | 6 +- .../components/openresponseserrormetadata.mdx | 2 +- .../openresponseserrormetadataalignment.mdx | 4 +- .../openresponsesinprogressevent.mdx | 6 +- docs/components/openresponsesresult.mdx | 76 ++--- .../openresponsesresulttoolfunction.mdx | 18 +- docs/components/openrouterfile.mdx | 16 +- docs/components/openrouterfiledeleted.mdx | 6 +- docs/components/openrouterfilelist.mdx | 12 +- docs/components/openroutermetadata.mdx | 22 +- .../openrouterwebsearchservertool.mdx | 4 +- docs/components/oranthropicbashtoolresult.mdx | 10 +- .../oranthropicbashtoolresultfile.mdx | 12 +- .../oranthropicservertooluseblock.mdx | 10 +- .../components/oranthropicshelltoolresult.mdx | 10 +- .../oranthropicshelltoolresultfile.mdx | 12 +- .../oranthropictoolsearchresult.mdx | 6 +- .../oranthropictoolsearchresultparam.mdx | 6 +- docs/components/organizationsettings.mdx | 4 +- docs/components/outcomeexit.mdx | 6 +- docs/components/outcometimeout.mdx | 4 +- .../outputadvisorservertoolitem.mdx | 16 +- docs/components/outputapplypatchcallitem.mdx | 10 +- .../outputapplypatchservertoolitem.mdx | 12 +- docs/components/outputarmorblockeditem.mdx | 18 +- docs/components/outputbashservertoolitem.mdx | 24 +- .../outputbashservertoolitemfile.mdx | 12 +- .../outputbrowseruseservertoolitem.mdx | 10 +- .../outputcodeinterpretercallitem.mdx | 14 +- .../outputcodeinterpreterservertoolitem.mdx | 16 +- docs/components/outputcomputercallitem.mdx | 12 +- docs/components/outputcustomtoolcallitem.mdx | 16 +- docs/components/outputdatetimeitem.mdx | 12 +- docs/components/outputfilesearchcallitem.mdx | 8 +- .../outputfilesearchservertoolitem.mdx | 8 +- docs/components/outputfilesservertoolitem.mdx | 20 +- docs/components/outputfunctioncallitem.mdx | 20 +- .../outputfunctioncallitemsubagentitem.mdx | 4 +- .../components/outputfusionservertoolitem.mdx | 18 +- .../outputfusionservertoolitemresponse.mdx | 4 +- .../outputimagegenerationcallitem.mdx | 10 +- .../outputimagegenerationservertoolitem.mdx | 18 +- docs/components/outputitemapplypatchcall.mdx | 12 +- .../outputitemcodeinterpretercall.mdx | 14 +- docs/components/outputitemcustomtoolcall.mdx | 16 +- docs/components/outputitemfilesearchcall.mdx | 8 +- docs/components/outputitemfunctioncall.mdx | 16 +- .../outputitemimagegenerationcall.mdx | 8 +- docs/components/outputitemreasoning.mdx | 12 +- docs/components/outputitemwebsearchcall.mdx | 10 +- ...utputitemwebsearchcallactionfindinpage.mdx | 6 +- .../outputitemwebsearchcallactionopenpage.mdx | 4 +- .../outputitemwebsearchcallactionsearch.mdx | 8 +- docs/components/outputmcpservertoolitem.mdx | 10 +- .../components/outputmemoryservertoolitem.mdx | 12 +- docs/components/outputmessage.mdx | 12 +- docs/components/outputmessageitem.mdx | 12 +- docs/components/outputreasoningitem.mdx | 16 +- .../outputsearchmodelsservertoolitem.mdx | 12 +- docs/components/outputshellcallitem.mdx | 12 +- docs/components/outputshellcallitemaction.mdx | 6 +- docs/components/outputshellcalloutputitem.mdx | 18 +- .../outputshellcalloutputitemfile.mdx | 12 +- docs/components/outputshellservertoolitem.mdx | 20 +- .../outputshellservertoolitemaction.mdx | 6 +- .../outputshellservertoolitemfile.mdx | 12 +- .../outputsubagentservertoolitem.mdx | 22 +- .../outputtexteditorservertoolitem.mdx | 10 +- docs/components/outputtokensdetails.mdx | 2 +- docs/components/outputtoolsearchcallitem.mdx | 12 +- .../outputtoolsearchservertoolitem.mdx | 12 +- .../outputwebfetchservertoolitem.mdx | 16 +- docs/components/outputwebsearchcallitem.mdx | 10 +- ...utputwebsearchcallitemactionfindinpage.mdx | 6 +- .../outputwebsearchcallitemactionopenpage.mdx | 4 +- .../outputwebsearchcallitemactionsearch.mdx | 8 +- .../outputwebsearchservertoolitem.mdx | 10 +- .../outputwebsearchservertoolitemaction.mdx | 6 +- .../outputwebsearchservertoolitemsource.mdx | 4 +- docs/components/paretorouterplugin.mdx | 10 +- docs/components/partialcoverage.mdx | 4 +- .../payloadtoolargeresponseerrordata.mdx | 6 +- .../paymentrequiredresponseerrordata.mdx | 6 +- docs/components/pdfparseroptions.mdx | 2 +- docs/components/pendingsafetycheck.mdx | 6 +- docs/components/percentilelatencycutoffs.mdx | 8 +- docs/components/percentilestats.mdx | 8 +- .../percentilethroughputcutoffs.mdx | 8 +- docs/components/perflast30mbyworkload.mdx | 18 +- docs/components/perrequestlimits.mdx | 4 +- docs/components/pipelinestage.mdx | 14 +- docs/components/prediction.mdx | 4 +- docs/components/predictioncontenttext.mdx | 4 +- docs/components/preset.mdx | 22 +- docs/components/presetdesignatedversion.mdx | 16 +- .../presetwithdesignatedversion.mdx | 24 +- .../preview20250311websearchservertool.mdx | 18 +- .../components/previewwebsearchservertool.mdx | 18 +- .../previewwebsearchuserlocation.mdx | 10 +- docs/components/pricing.mdx | 32 +- docs/components/pricingoverride.mdx | 22 +- docs/components/privateendpoint.mdx | 24 +- docs/components/privateendpointactivation.mdx | 2 +- docs/components/privateendpointcheck.mdx | 12 +- docs/components/privateendpointpricing.mdx | 4 +- docs/components/privateendpointresponse.mdx | 2 +- docs/components/privateendpointsummary.mdx | 14 +- docs/components/privateendpointvalidation.mdx | 4 +- .../privateendpointvalidationnullable.mdx | 4 +- .../privateendpointvalidationresponse.mdx | 2 +- docs/components/progress.mdx | 6 +- docs/components/promptcachebreakpoint.mdx | 2 +- docs/components/promptcacheoptions.mdx | 4 +- docs/components/provideroptions.mdx | 292 ++++++++--------- .../provideroverloadedresponseerrordata.mdx | 6 +- docs/components/providerpreferences.mdx | 28 +- docs/components/providerresponse.mdx | 16 +- docs/components/providersortconfig.mdx | 4 +- docs/components/provisioninternresponse.mdx | 2 +- docs/components/publicendpoint.mdx | 48 +-- docs/components/publicpricing.mdx | 32 +- docs/components/rangecapability.mdx | 6 +- docs/components/rankingoptions.mdx | 4 +- docs/components/rankingsdailyitem.mdx | 6 +- docs/components/rankingsdailymeta.mdx | 8 +- docs/components/rankingsdailyresponse.mdx | 4 +- docs/components/reasoningconfig.mdx | 12 +- docs/components/reasoningdeltaevent.mdx | 12 +- docs/components/reasoningdetailencrypted.mdx | 10 +- .../reasoningdetailservertoolcall.mdx | 16 +- docs/components/reasoningdetailsummary.mdx | 10 +- docs/components/reasoningdetailtext.mdx | 12 +- docs/components/reasoningdoneevent.mdx | 12 +- docs/components/reasoningitem.mdx | 16 +- .../reasoningsummarypartaddedevent.mdx | 12 +- .../reasoningsummarypartdoneevent.mdx | 12 +- docs/components/reasoningsummarytext.mdx | 4 +- .../reasoningsummarytextdeltaevent.mdx | 12 +- .../reasoningsummarytextdoneevent.mdx | 12 +- docs/components/reasoningtextcontent.mdx | 4 +- docs/components/refusal.mdx | 8 +- docs/components/refusaldeltaevent.mdx | 12 +- docs/components/refusaldoneevent.mdx | 12 +- docs/components/refusaltoplogprob.mdx | 6 +- docs/components/request.mdx | 4 +- .../requesttimeoutresponseerrordata.mdx | 6 +- docs/components/requireapproval.mdx | 4 +- docs/components/rerank.mdx | 6 +- docs/components/responsehealingplugin.mdx | 4 +- docs/components/responseoutputtext.mdx | 8 +- .../responseoutputtexttoplogprob.mdx | 6 +- docs/components/responsesrequest.mdx | 80 ++--- .../responsesrequesttoolfunction.mdx | 18 +- .../components/responsesstreamingresponse.mdx | 2 +- docs/components/result.mdx | 8 +- docs/components/resulterror.mdx | 8 +- docs/components/routerattempt.mdx | 6 +- docs/components/routerparams.mdx | 8 +- docs/components/rule.mdx | 6 +- docs/components/scimgroup.mdx | 12 +- docs/components/scimgroupmapping.mdx | 14 +- docs/components/scimsyncjob.mdx | 16 +- .../searchmodelsservertoolconfig.mdx | 2 +- .../searchmodelsservertoolopenrouter.mdx | 4 +- docs/components/security.mdx | 2 +- docs/components/servertool.mdx | 30 +- docs/components/servertooldetails.mdx | 30 +- docs/components/servertoolengine.mdx | 18 +- docs/components/servertoolinputname.mdx | 6 +- docs/components/servertoolnativemodel.mdx | 4 +- docs/components/servertoolnativesupport.mdx | 4 +- docs/components/servertooloutputname.mdx | 6 +- docs/components/servertoolprice.mdx | 8 +- docs/components/servertoolusedetails.mdx | 6 +- .../serviceunavailableresponseerrordata.mdx | 6 +- docs/components/sessioncostitem.mdx | 10 +- docs/components/sessioncostmeta.mdx | 8 +- docs/components/sessioncostresponse.mdx | 4 +- docs/components/shellcallitem.mdx | 14 +- docs/components/shellcallitemaction.mdx | 6 +- docs/components/shellcalloutputcontent.mdx | 8 +- docs/components/shellcalloutputitem.mdx | 18 +- docs/components/shellcalloutputitemfile.mdx | 12 +- docs/components/shellservertool.mdx | 2 +- docs/components/shellservertoolconfig.mdx | 4 +- docs/components/shellservertoolopenrouter.mdx | 4 +- docs/components/signinterndaemonrequest.mdx | 2 +- docs/components/signinterndaemonresponse.mdx | 6 +- docs/components/sourcecontent.mdx | 4 +- docs/components/speechinput.mdx | 2 +- docs/components/speechinputreferenceaudio.mdx | 4 +- .../speechinputreferenceaudioinput.mdx | 6 +- docs/components/speechinputreferenceimage.mdx | 4 +- .../speechinputreferenceimageinput.mdx | 2 +- docs/components/speechinputreferencetext.mdx | 4 +- docs/components/speechrequest.mdx | 22 +- docs/components/speechrequestprovider.mdx | 6 +- docs/components/speechturn.mdx | 6 +- docs/components/stance.mdx | 4 +- .../stopservertoolswhenfinishreasonis.mdx | 4 +- .../stopservertoolswhenhastoolcall.mdx | 4 +- .../components/stopservertoolswhenmaxcost.mdx | 4 +- .../stopservertoolswhenmaxtokensused.mdx | 4 +- .../stopservertoolswhenstepcountis.mdx | 4 +- docs/components/storedprompttemplate.mdx | 4 +- .../streameventsresponsecompleted.mdx | 6 +- .../components/streameventsresponsefailed.mdx | 6 +- .../streameventsresponseincomplete.mdx | 6 +- .../streameventsresponseoutputitemadded.mdx | 8 +- .../streameventsresponseoutputitemdone.mdx | 8 +- docs/components/streamlogprob.mdx | 8 +- docs/components/streamlogprobtoplogprob.mdx | 6 +- docs/components/stt.mdx | 6 +- docs/components/sttentity.mdx | 8 +- docs/components/sttinlineinputaudio.mdx | 4 +- docs/components/sttrequest.mdx | 24 +- docs/components/sttrequestprovider.mdx | 6 +- docs/components/sttresponse.mdx | 20 +- docs/components/sttsegment.mdx | 26 +- docs/components/stturlinputaudio.mdx | 4 +- docs/components/sttusage.mdx | 10 +- docs/components/sttword.mdx | 16 +- docs/components/subagentnestedtool.mdx | 6 +- docs/components/subagentreasoning.mdx | 4 +- docs/components/subagentservertoolconfig.mdx | 20 +- .../subagentservertoolopenrouter.mdx | 4 +- .../submitgenerationfeedbackrequest.mdx | 6 +- .../submitgenerationfeedbackresponse.mdx | 2 +- .../submitgenerationfeedbackresponsedata.mdx | 2 +- docs/components/suspendinternresponse.mdx | 2 +- docs/components/switchyardrouterplugin.mdx | 6 +- docs/components/taskbudget.mdx | 6 +- docs/components/taskclassificationitem.mdx | 16 +- .../taskclassificationmacrocategory.mdx | 8 +- docs/components/taskclassificationmodel.mdx | 6 +- .../components/taskclassificationresponse.mdx | 2 +- .../taskclassificationresponsedata.mdx | 8 +- docs/components/textdeltaevent.mdx | 14 +- docs/components/textdoneevent.mdx | 14 +- docs/components/textextendedconfig.mdx | 4 +- docs/components/textgeneration.mdx | 6 +- docs/components/thinkingadaptive.mdx | 6 +- docs/components/thinkingbetweentools.mdx | 2 +- docs/components/thinkingdisabled.mdx | 2 +- docs/components/thinkingenabled.mdx | 8 +- docs/components/tokenexchangerequest.mdx | 12 +- docs/components/tokenexchangeresponse.mdx | 10 +- docs/components/tooladvisor20260301.mdx | 16 +- docs/components/toolbash20250124.mdx | 6 +- docs/components/toolcall.mdx | 8 +- docs/components/toolchoiceallowed.mdx | 6 +- docs/components/toolchoiceany.mdx | 4 +- docs/components/toolchoiceauto.mdx | 4 +- docs/components/toolchoicenone.mdx | 2 +- docs/components/toolchoicesupport.mdx | 8 +- docs/components/toolchoicetool.mdx | 6 +- docs/components/toolcustom.mdx | 14 +- docs/components/toolsearchcallitem.mdx | 12 +- docs/components/toolsearchoutputitem.mdx | 12 +- docs/components/toolsearchoutputitemtool.mdx | 4 +- .../toolsearchoutputitemtoolfunction.mdx | 18 +- docs/components/toolsearchservertool.mdx | 4 +- .../components/toolsearchservertoolconfig.mdx | 2 +- docs/components/tooltexteditor20250124.mdx | 6 +- docs/components/toolwebsearch20250305.mdx | 14 +- docs/components/toolwebsearch20260209.mdx | 16 +- .../toomanyrequestsresponseerrordata.mdx | 6 +- docs/components/topproviderinfo.mdx | 6 +- docs/components/tournamentstats.mdx | 10 +- docs/components/traceconfig.mdx | 12 +- docs/components/triggerinputtokens.mdx | 4 +- docs/components/tts.mdx | 6 +- .../unauthorizedresponseerrordata.mdx | 6 +- docs/components/unifiedbenchmarkpricing.mdx | 4 +- docs/components/unifiedbenchmarksaaitem.mdx | 14 +- docs/components/unifiedbenchmarksdaitem.mdx | 20 +- docs/components/unifiedbenchmarksmeta.mdx | 14 +- docs/components/unifiedbenchmarksoritem.mdx | 18 +- docs/components/unifiedbenchmarksresponse.mdx | 4 +- .../unifiedbenchmarkssearchitem.mdx | 26 +- .../unifiedbenchmarkssearchrunconfig.mdx | 6 +- docs/components/uniqueinsight.mdx | 4 +- docs/components/unknown.mdx | 6 +- .../unprocessableentityresponseerrordata.mdx | 6 +- docs/components/updatebyokkeyrequest.mdx | 22 +- docs/components/updatebyokkeyresponse.mdx | 2 +- docs/components/updateenduserrequest.mdx | 2 +- docs/components/updateguardrailrequest.mdx | 43 +-- docs/components/updateguardrailresponse.mdx | 2 +- docs/components/updateinternrequest.mdx | 8 +- .../updateobservabilitydestinationrequest.mdx | 24 +- ...updateobservabilitydestinationresponse.mdx | 2 +- .../updateorganizationsettingsrequest.mdx | 2 +- .../updateprivateendpointpricingrequest.mdx | 2 +- .../updateprivateendpointrequest.mdx | 8 +- .../updatescimgroupmappingrequest.mdx | 2 +- .../updatescimgroupmappingresponse.mdx | 2 +- docs/components/updateworkspacerequest.mdx | 24 +- docs/components/updateworkspaceresponse.mdx | 2 +- docs/components/upscalefactor.mdx | 4 +- .../upsertworkspacebudgetrequest.mdx | 4 +- .../upsertworkspacebudgetresponse.mdx | 4 +- docs/components/upstream.mdx | 4 +- docs/components/urlcitation.mdx | 12 +- docs/components/usage.mdx | 18 +- docs/components/usagecostdetails.mdx | 8 +- docs/components/userlocation.mdx | 10 +- .../validateprivateendpointrequest.mdx | 2 +- docs/components/vaulteffectivesecret.mdx | 10 +- .../vaulteffectivesecretlistresponse.mdx | 4 +- docs/components/vaultsecret.mdx | 8 +- docs/components/vaultsecretcopyrequest.mdx | 2 +- docs/components/vaultsecretcopyresponse.mdx | 2 +- docs/components/vaultsecretlistresponse.mdx | 4 +- docs/components/vaultsecretresponse.mdx | 2 +- docs/components/vaultsecretwriterequest.mdx | 4 +- docs/components/videogeneration.mdx | 6 +- docs/components/videogenerationrequest.mdx | 36 +-- .../videogenerationrequestoptions.mdx | 292 ++++++++--------- .../videogenerationrequestprovider.mdx | 2 +- docs/components/videogenerationresponse.mdx | 16 +- docs/components/videogenerationusage.mdx | 4 +- docs/components/videomodel.mdx | 34 +- docs/components/videomodelslistresponse.mdx | 2 +- docs/components/videourl.mdx | 2 +- docs/components/webfetchplugin.mdx | 10 +- docs/components/webfetchservertool.mdx | 4 +- docs/components/webfetchservertoolconfig.mdx | 10 +- .../websearchcallcompletedevent.mdx | 8 +- .../websearchcallinprogressevent.mdx | 8 +- .../websearchcallsearchingevent.mdx | 8 +- docs/components/websearchcitation.mdx | 8 +- docs/components/websearchconfig.mdx | 22 +- docs/components/websearchdomainfilter.mdx | 6 +- docs/components/websearchplugin.mdx | 22 +- docs/components/websearchservertool.mdx | 18 +- docs/components/websearchservertoolconfig.mdx | 22 +- .../websearchservertoolopenrouter.mdx | 4 +- docs/components/websearchsource.mdx | 4 +- docs/components/websearchuserlocation.mdx | 10 +- .../websearchuserlocationservertool.mdx | 10 +- docs/components/workspace.mdx | 36 +-- docs/components/workspacebudget.mdx | 12 +- docs/components/workspacemember.mdx | 10 +- docs/components/xsearchoptions.mdx | 12 +- docs/errors/badgatewayresponseerror.mdx | 6 +- docs/errors/badrequestresponseerror.mdx | 6 +- docs/errors/batcherrorresponse.mdx | 2 +- .../batchpaymentrequiredresponseerror.mdx | 24 +- docs/errors/conflictresponseerror.mdx | 6 +- ...eendpointvalidationfailedresponseerror.mdx | 4 +- .../edgenetworktimeoutresponseerror.mdx | 6 +- docs/errors/forbiddenresponseerror.mdx | 6 +- docs/errors/gatewaytimeoutresponseerror.mdx | 6 +- docs/errors/goneresponseerror.mdx | 6 +- docs/errors/internalserverresponseerror.mdx | 6 +- docs/errors/internchaterrorresponse.mdx | 2 +- docs/errors/internlifecycleerror.mdx | 2 +- docs/errors/notfoundresponseerror.mdx | 6 +- docs/errors/oautherrorresponse.mdx | 4 +- docs/errors/payloadtoolargeresponseerror.mdx | 6 +- docs/errors/paymentrequiredresponseerror.mdx | 6 +- .../provideroverloadedresponseerror.mdx | 6 +- docs/errors/requesttimeoutresponseerror.mdx | 6 +- .../serviceunavailableresponseerror.mdx | 6 +- docs/errors/toomanyrequestsresponseerror.mdx | 6 +- docs/errors/unauthorizedresponseerror.mdx | 6 +- .../unprocessableentityresponseerror.mdx | 6 +- docs/models/internal/globals.mdx | 6 +- .../activateprivateendpointglobals.mdx | 6 +- .../activateprivateendpointrequest.mdx | 8 +- .../bulkaddworkspacemembersglobals.mdx | 6 +- .../bulkaddworkspacemembersrequest.mdx | 10 +- .../bulkassignkeystoguardrailglobals.mdx | 6 +- .../bulkassignkeystoguardrailrequest.mdx | 10 +- .../bulkassignmemberstoguardrailglobals.mdx | 6 +- .../bulkassignmemberstoguardrailrequest.mdx | 10 +- .../bulkremoveworkspacemembersglobals.mdx | 6 +- .../bulkremoveworkspacemembersrequest.mdx | 10 +- .../bulkunassignkeysfromguardrailglobals.mdx | 6 +- .../bulkunassignkeysfromguardrailrequest.mdx | 10 +- ...ulkunassignmembersfromguardrailglobals.mdx | 6 +- ...ulkunassignmembersfromguardrailrequest.mdx | 10 +- docs/operations/classifierdimensions.mdx | 6 +- docs/operations/classifierfilters.mdx | 4 +- docs/operations/classifierfiltersfilter.mdx | 6 +- docs/operations/contentimageurl.mdx | 4 +- docs/operations/contenttext.mdx | 4 +- .../copyvaultsecretstointernglobals.mdx | 6 +- .../copyvaultsecretstointernrequest.mdx | 10 +- .../createapialphadecisionsglobals.mdx | 6 +- .../createapialphadecisionsrequest.mdx | 8 +- docs/operations/createaudiospeechglobals.mdx | 6 +- docs/operations/createaudiospeechrequest.mdx | 8 +- .../createaudiotranscriptionsglobals.mdx | 6 +- ...createaudiotranscriptionsmultipartfile.mdx | 6 +- ...ateaudiotranscriptionsmultipartglobals.mdx | 6 +- ...ateaudiotranscriptionsmultipartrequest.mdx | 8 +- ...udiotranscriptionsmultipartrequestbody.mdx | 26 +- .../createaudiotranscriptionsrequest.mdx | 8 +- docs/operations/createauthkeyscodedata.mdx | 6 +- docs/operations/createauthkeyscodeglobals.mdx | 6 +- docs/operations/createauthkeyscoderequest.mdx | 8 +- .../createauthkeyscoderequestbody.mdx | 16 +- .../operations/createauthkeyscoderesponse.mdx | 2 +- docs/operations/createbatchesglobals.mdx | 6 +- docs/operations/createbatchesrequest.mdx | 8 +- docs/operations/createbyokkeyglobals.mdx | 6 +- docs/operations/createbyokkeyrequest.mdx | 8 +- docs/operations/createembeddingsdata.mdx | 6 +- docs/operations/createembeddingsglobals.mdx | 6 +- docs/operations/createembeddingsrequest.mdx | 8 +- .../createembeddingsrequestbody.mdx | 18 +- .../createembeddingsresponsebody.mdx | 10 +- docs/operations/createembeddingsusage.mdx | 12 +- docs/operations/createenduserglobals.mdx | 6 +- docs/operations/createenduserrequest.mdx | 8 +- docs/operations/createguardrailglobals.mdx | 6 +- docs/operations/createguardrailrequest.mdx | 8 +- docs/operations/createimagesglobals.mdx | 6 +- docs/operations/createimagesrequest.mdx | 8 +- .../createinternchatcompletionglobals.mdx | 6 +- .../createinternchatcompletionrequest.mdx | 10 +- .../createinternchatcompletionresponse.mdx | 4 +- docs/operations/createinternglobals.mdx | 6 +- docs/operations/createinternrequest.mdx | 10 +- docs/operations/createkeysdata.mdx | 46 +-- docs/operations/createkeysglobals.mdx | 6 +- docs/operations/createkeysrequest.mdx | 8 +- docs/operations/createkeysrequestbody.mdx | 16 +- docs/operations/createkeysresponse.mdx | 4 +- docs/operations/createoauthtokenglobals.mdx | 6 +- docs/operations/createoauthtokenrequest.mdx | 8 +- .../createobservabilitydestinationglobals.mdx | 6 +- .../createobservabilitydestinationrequest.mdx | 8 +- .../createpresetschatcompletionsglobals.mdx | 6 +- .../createpresetschatcompletionsrequest.mdx | 10 +- .../createpresetsmessagesglobals.mdx | 6 +- .../createpresetsmessagesrequest.mdx | 10 +- .../createpresetsresponsesglobals.mdx | 6 +- .../createpresetsresponsesrequest.mdx | 10 +- .../createprivateendpointglobals.mdx | 6 +- .../createprivateendpointrequest.mdx | 10 +- docs/operations/creatererankglobals.mdx | 6 +- docs/operations/creatererankrequest.mdx | 8 +- docs/operations/creatererankrequestbody.mdx | 16 +- docs/operations/creatererankresponsebody.mdx | 10 +- docs/operations/creatererankusage.mdx | 6 +- docs/operations/createresponsesglobals.mdx | 6 +- docs/operations/createresponsesrequest.mdx | 10 +- .../createscimgroupmappingglobals.mdx | 6 +- .../createscimgroupmappingrequest.mdx | 8 +- docs/operations/createscimsyncjobglobals.mdx | 6 +- docs/operations/createscimsyncjobrequest.mdx | 6 +- docs/operations/createscimsyncjobresponse.mdx | 4 +- docs/operations/createsystemoneglobals.mdx | 6 +- docs/operations/createsystemonerequest.mdx | 8 +- docs/operations/createvideosglobals.mdx | 6 +- docs/operations/createvideosrequest.mdx | 8 +- docs/operations/createworkspaceglobals.mdx | 6 +- docs/operations/createworkspacerequest.mdx | 8 +- docs/operations/deletebatchglobals.mdx | 6 +- docs/operations/deletebatchrequest.mdx | 8 +- docs/operations/deletebyokkeyglobals.mdx | 6 +- docs/operations/deletebyokkeyrequest.mdx | 8 +- docs/operations/deleteenduserglobals.mdx | 6 +- docs/operations/deleteenduserrequest.mdx | 8 +- docs/operations/deletefileglobals.mdx | 6 +- docs/operations/deletefilerequest.mdx | 12 +- docs/operations/deleteguardrailglobals.mdx | 6 +- docs/operations/deleteguardrailrequest.mdx | 8 +- docs/operations/deleteinternglobals.mdx | 6 +- docs/operations/deleteinternrequest.mdx | 10 +- .../deleteinternvaultsecretglobals.mdx | 6 +- .../deleteinternvaultsecretrequest.mdx | 10 +- docs/operations/deletekeysglobals.mdx | 6 +- docs/operations/deletekeysrequest.mdx | 8 +- docs/operations/deletekeysresponse.mdx | 2 +- .../deleteobservabilitydestinationglobals.mdx | 6 +- .../deleteobservabilitydestinationrequest.mdx | 8 +- .../deleteprivateendpointglobals.mdx | 6 +- .../deleteprivateendpointrequest.mdx | 10 +- .../deletescimgroupmappingglobals.mdx | 6 +- .../deletescimgroupmappingrequest.mdx | 10 +- docs/operations/deletevaultsecretglobals.mdx | 6 +- docs/operations/deletevaultsecretrequest.mdx | 8 +- .../deleteworkspacebudgetglobals.mdx | 6 +- .../deleteworkspacebudgetrequest.mdx | 10 +- docs/operations/deleteworkspaceglobals.mdx | 6 +- docs/operations/deleteworkspacerequest.mdx | 10 +- docs/operations/dimension.mdx | 4 +- .../disableprivateendpointglobals.mdx | 6 +- .../disableprivateendpointrequest.mdx | 8 +- docs/operations/documentrequest.mdx | 4 +- docs/operations/documentresponse.mdx | 4 +- .../downloadcontainerfilecontentglobals.mdx | 6 +- .../downloadcontainerfilecontentrequest.mdx | 10 +- .../operations/downloadfilecontentglobals.mdx | 6 +- .../operations/downloadfilecontentrequest.mdx | 12 +- .../enableprivateendpointglobals.mdx | 6 +- .../enableprivateendpointrequest.mdx | 8 +- .../exchangeauthcodeforapikeyglobals.mdx | 6 +- .../exchangeauthcodeforapikeyrequest.mdx | 8 +- .../exchangeauthcodeforapikeyrequestbody.mdx | 6 +- .../exchangeauthcodeforapikeyresponse.mdx | 4 +- docs/operations/external.mdx | 4 +- docs/operations/filter_.mdx | 8 +- docs/operations/getanalyticsmetadata.mdx | 8 +- docs/operations/getanalyticsmetaglobals.mdx | 6 +- docs/operations/getanalyticsmetarequest.mdx | 6 +- docs/operations/getanalyticsmetaresponse.mdx | 2 +- docs/operations/getapprankingsglobals.mdx | 6 +- docs/operations/getapprankingsrequest.mdx | 20 +- docs/operations/getapprankingsresponse.mdx | 2 +- docs/operations/getbatchesglobals.mdx | 6 +- docs/operations/getbatchesrequest.mdx | 8 +- docs/operations/getbenchmarksglobals.mdx | 6 +- docs/operations/getbenchmarksrequest.mdx | 24 +- docs/operations/getbyokkeyglobals.mdx | 6 +- docs/operations/getbyokkeyrequest.mdx | 8 +- docs/operations/getcontainerfileglobals.mdx | 6 +- docs/operations/getcontainerfilerequest.mdx | 10 +- docs/operations/getcreditsdata.mdx | 4 +- docs/operations/getcreditsglobals.mdx | 6 +- docs/operations/getcreditsrequest.mdx | 6 +- docs/operations/getcreditsresponse.mdx | 2 +- docs/operations/getcurrentkeydata.mdx | 50 +-- docs/operations/getcurrentkeyglobals.mdx | 6 +- docs/operations/getcurrentkeyrequest.mdx | 6 +- docs/operations/getcurrentkeyresponse.mdx | 2 +- docs/operations/getenduserglobals.mdx | 6 +- docs/operations/getenduserrequest.mdx | 8 +- docs/operations/getfilemetadataglobals.mdx | 6 +- docs/operations/getfilemetadatarequest.mdx | 12 +- docs/operations/getgenerationglobals.mdx | 6 +- docs/operations/getgenerationrequest.mdx | 8 +- docs/operations/getguardrailglobals.mdx | 6 +- docs/operations/getguardrailrequest.mdx | 8 +- .../getinterndaemonaccessglobals.mdx | 6 +- .../getinterndaemonaccessrequest.mdx | 8 +- docs/operations/getinterndaemonglobals.mdx | 6 +- docs/operations/getinterndaemonrequest.mdx | 8 +- docs/operations/getinternglobals.mdx | 6 +- docs/operations/getinternrequest.mdx | 8 +- docs/operations/getkeydata.mdx | 46 +-- docs/operations/getkeyglobals.mdx | 6 +- docs/operations/getkeyrequest.mdx | 8 +- docs/operations/getkeyresponse.mdx | 2 +- docs/operations/getmodelglobals.mdx | 6 +- docs/operations/getmodelrequest.mdx | 10 +- docs/operations/getmodelsglobals.mdx | 6 +- docs/operations/getmodelsrequest.mdx | 64 ++-- docs/operations/getmodelsresponse.mdx | 2 +- .../getobservabilitydestinationglobals.mdx | 6 +- .../getobservabilitydestinationrequest.mdx | 8 +- .../getorganizationsettingsglobals.mdx | 6 +- .../getorganizationsettingsrequest.mdx | 6 +- .../getorganizationsettingsresponse.mdx | 2 +- docs/operations/getpresetglobals.mdx | 6 +- docs/operations/getpresetrequest.mdx | 8 +- docs/operations/getpresetversionglobals.mdx | 6 +- docs/operations/getpresetversionrequest.mdx | 10 +- docs/operations/getprivateendpointglobals.mdx | 6 +- docs/operations/getprivateendpointrequest.mdx | 8 +- docs/operations/getrankingsdailyglobals.mdx | 6 +- docs/operations/getrankingsdailyrequest.mdx | 20 +- .../operations/getscimgroupmappingglobals.mdx | 6 +- .../operations/getscimgroupmappingrequest.mdx | 8 +- docs/operations/getscimsyncjobglobals.mdx | 6 +- docs/operations/getscimsyncjobrequest.mdx | 8 +- docs/operations/getsessioncostglobals.mdx | 6 +- docs/operations/getsessioncostrequest.mdx | 16 +- docs/operations/getsessioncostresponse.mdx | 2 +- .../gettaskclassificationsglobals.mdx | 6 +- .../gettaskclassificationsrequest.mdx | 8 +- docs/operations/gettoolglobals.mdx | 6 +- docs/operations/gettoolrequest.mdx | 8 +- docs/operations/gettoolresponse.mdx | 4 +- docs/operations/gettoolsecurity.mdx | 2 +- docs/operations/getuseractivityglobals.mdx | 6 +- docs/operations/getuseractivityrequest.mdx | 16 +- docs/operations/getvideosglobals.mdx | 6 +- docs/operations/getvideosrequest.mdx | 8 +- docs/operations/getworkspacebudgetglobals.mdx | 6 +- docs/operations/getworkspacebudgetrequest.mdx | 10 +- docs/operations/getworkspaceglobals.mdx | 6 +- docs/operations/getworkspacerequest.mdx | 8 +- docs/operations/granularity.mdx | 4 +- docs/operations/imageurl.mdx | 2 +- docs/operations/input.mdx | 2 +- docs/operations/invokeinternglobals.mdx | 6 +- docs/operations/invokeinternrequest.mdx | 10 +- docs/operations/invokeinternresponse.mdx | 4 +- docs/operations/listbatchesglobals.mdx | 6 +- docs/operations/listbatchesrequest.mdx | 16 +- docs/operations/listbatchesresponse.mdx | 2 +- docs/operations/listbyokkeysglobals.mdx | 6 +- docs/operations/listbyokkeysrequest.mdx | 14 +- docs/operations/listbyokkeysresponse.mdx | 2 +- docs/operations/listcontainerfilesglobals.mdx | 6 +- docs/operations/listcontainerfilesrequest.mdx | 12 +- docs/operations/listdata.mdx | 46 +-- .../listembeddingsmodelsglobals.mdx | 6 +- .../listembeddingsmodelsrequest.mdx | 10 +- .../listembeddingsmodelsresponse.mdx | 2 +- docs/operations/listendpointsglobals.mdx | 6 +- docs/operations/listendpointsrequest.mdx | 10 +- docs/operations/listendpointsresponse.mdx | 2 +- docs/operations/listendpointszdrglobals.mdx | 6 +- docs/operations/listendpointszdrrequest.mdx | 6 +- docs/operations/listendpointszdrresponse.mdx | 2 +- docs/operations/listendusersglobals.mdx | 6 +- docs/operations/listendusersrequest.mdx | 14 +- docs/operations/listendusersresponse.mdx | 2 +- docs/operations/listfilesglobals.mdx | 6 +- docs/operations/listfilesrequest.mdx | 22 +- docs/operations/listfilesresponse.mdx | 2 +- .../listgenerationcontentglobals.mdx | 6 +- .../listgenerationcontentrequest.mdx | 8 +- docs/operations/listglobals.mdx | 6 +- .../listguardrailkeyassignmentsglobals.mdx | 6 +- .../listguardrailkeyassignmentsrequest.mdx | 12 +- .../listguardrailkeyassignmentsresponse.mdx | 2 +- .../listguardrailmemberassignmentsglobals.mdx | 6 +- .../listguardrailmemberassignmentsrequest.mdx | 12 +- ...listguardrailmemberassignmentsresponse.mdx | 2 +- docs/operations/listguardrailsglobals.mdx | 6 +- docs/operations/listguardrailsrequest.mdx | 12 +- docs/operations/listguardrailsresponse.mdx | 2 +- .../listimagemodelendpointsglobals.mdx | 6 +- .../listimagemodelendpointsrequest.mdx | 10 +- docs/operations/listimagemodelsglobals.mdx | 6 +- docs/operations/listimagemodelsrequest.mdx | 6 +- ...listinterneffectivevaultsecretsglobals.mdx | 6 +- ...listinterneffectivevaultsecretsrequest.mdx | 12 +- docs/operations/listinternsglobals.mdx | 6 +- docs/operations/listinternsrequest.mdx | 14 +- .../listinternvaultsecretsglobals.mdx | 6 +- .../listinternvaultsecretsrequest.mdx | 12 +- docs/operations/listkeyassignmentsglobals.mdx | 6 +- docs/operations/listkeyassignmentsrequest.mdx | 10 +- .../operations/listkeyassignmentsresponse.mdx | 2 +- .../listmemberassignmentsglobals.mdx | 6 +- .../listmemberassignmentsrequest.mdx | 10 +- .../listmemberassignmentsresponse.mdx | 2 +- docs/operations/listmodelscountglobals.mdx | 6 +- docs/operations/listmodelscountrequest.mdx | 8 +- docs/operations/listmodelsuserglobals.mdx | 6 +- docs/operations/listmodelsuserrequest.mdx | 12 +- docs/operations/listmodelsuserresponse.mdx | 2 +- docs/operations/listmodelsusersecurity.mdx | 2 +- docs/operations/listoauthjwksglobals.mdx | 6 +- docs/operations/listoauthjwksrequest.mdx | 6 +- .../listobservabilitydestinationsglobals.mdx | 6 +- .../listobservabilitydestinationsrequest.mdx | 12 +- .../listobservabilitydestinationsresponse.mdx | 2 +- .../listorganizationmembersdata.mdx | 10 +- .../listorganizationmembersglobals.mdx | 6 +- .../listorganizationmembersrequest.mdx | 10 +- .../listorganizationmembersresponse.mdx | 2 +- .../listorganizationmembersresponsebody.mdx | 4 +- docs/operations/listpresetsglobals.mdx | 6 +- docs/operations/listpresetsrequest.mdx | 10 +- docs/operations/listpresetsresponse.mdx | 2 +- docs/operations/listpresetversionsglobals.mdx | 6 +- docs/operations/listpresetversionsrequest.mdx | 12 +- .../operations/listpresetversionsresponse.mdx | 2 +- .../listprivateendpointsglobals.mdx | 6 +- .../listprivateendpointsrequest.mdx | 6 +- docs/operations/listprovidersdata.mdx | 14 +- docs/operations/listprovidersglobals.mdx | 6 +- docs/operations/listprovidersrequest.mdx | 6 +- docs/operations/listprovidersresponse.mdx | 2 +- docs/operations/listrequest.mdx | 14 +- docs/operations/listresponse.mdx | 2 +- .../listscimgroupmappingsglobals.mdx | 6 +- .../listscimgroupmappingsrequest.mdx | 10 +- .../listscimgroupmappingsresponse.mdx | 2 +- docs/operations/listscimgroupsglobals.mdx | 6 +- docs/operations/listscimgroupsrequest.mdx | 14 +- docs/operations/listscimgroupsresponse.mdx | 2 +- docs/operations/listtoolsglobals.mdx | 6 +- docs/operations/listtoolsrequest.mdx | 12 +- docs/operations/listtoolssecurity.mdx | 2 +- docs/operations/listvaultsecretsglobals.mdx | 6 +- docs/operations/listvaultsecretsrequest.mdx | 10 +- docs/operations/listvideoscontentglobals.mdx | 6 +- docs/operations/listvideoscontentrequest.mdx | 10 +- docs/operations/listvideosmodelsglobals.mdx | 6 +- docs/operations/listvideosmodelsrequest.mdx | 6 +- .../listworkspacebudgetsglobals.mdx | 6 +- .../listworkspacebudgetsrequest.mdx | 8 +- .../listworkspacemembersglobals.mdx | 6 +- .../listworkspacemembersrequest.mdx | 12 +- .../listworkspacemembersresponse.mdx | 2 +- docs/operations/listworkspacesglobals.mdx | 6 +- docs/operations/listworkspacesrequest.mdx | 10 +- docs/operations/listworkspacesresponse.mdx | 2 +- docs/operations/metadata.mdx | 6 +- docs/operations/metric.mdx | 8 +- docs/operations/operator.mdx | 4 +- docs/operations/orderby.mdx | 4 +- .../promotecontainerfileglobals.mdx | 6 +- .../promotecontainerfilerequest.mdx | 10 +- docs/operations/prompttokensdetails.mdx | 10 +- docs/operations/provisioninternglobals.mdx | 6 +- docs/operations/provisioninternrequest.mdx | 8 +- docs/operations/queryanalyticsdata2.mdx | 8 +- docs/operations/queryanalyticsglobals.mdx | 6 +- docs/operations/queryanalyticsrequest.mdx | 8 +- docs/operations/queryanalyticsrequestbody.mdx | 20 +- docs/operations/queryanalyticsresponse.mdx | 2 +- docs/operations/ratelimit.mdx | 8 +- docs/operations/result.mdx | 6 +- .../sendchatcompletionrequestglobals.mdx | 6 +- .../sendchatcompletionrequestrequest.mdx | 10 +- .../signinterndaemonaccessrequestglobals.mdx | 6 +- .../signinterndaemonaccessrequestrequest.mdx | 10 +- .../signinterndaemonaccessrequestresponse.mdx | 4 +- .../signinterndaemonrequestglobals.mdx | 6 +- .../signinterndaemonrequestrequest.mdx | 10 +- .../signinterndaemonrequestresponse.mdx | 4 +- .../storeinternvaultsecretglobals.mdx | 6 +- .../storeinternvaultsecretrequest.mdx | 12 +- docs/operations/storevaultsecretglobals.mdx | 6 +- docs/operations/storevaultsecretrequest.mdx | 10 +- .../submitgenerationfeedbackglobals.mdx | 6 +- .../submitgenerationfeedbackrequest.mdx | 8 +- docs/operations/suspendinternglobals.mdx | 6 +- docs/operations/suspendinternrequest.mdx | 8 +- docs/operations/timerange.mdx | 4 +- docs/operations/updatebyokkeyglobals.mdx | 6 +- docs/operations/updatebyokkeyrequest.mdx | 10 +- docs/operations/updateenduserglobals.mdx | 6 +- docs/operations/updateenduserrequest.mdx | 10 +- docs/operations/updateguardrailglobals.mdx | 6 +- docs/operations/updateguardrailrequest.mdx | 10 +- docs/operations/updateinternglobals.mdx | 6 +- docs/operations/updateinternrequest.mdx | 10 +- docs/operations/updatekeysdata.mdx | 46 +-- docs/operations/updatekeysglobals.mdx | 6 +- docs/operations/updatekeysrequest.mdx | 10 +- docs/operations/updatekeysrequestbody.mdx | 12 +- docs/operations/updatekeysresponse.mdx | 2 +- .../updateobservabilitydestinationglobals.mdx | 6 +- .../updateobservabilitydestinationrequest.mdx | 10 +- .../updateorganizationsettingsglobals.mdx | 6 +- .../updateorganizationsettingsrequest.mdx | 8 +- .../updateorganizationsettingsresponse.mdx | 2 +- .../updateprivateendpointglobals.mdx | 6 +- .../updateprivateendpointpricingglobals.mdx | 6 +- .../updateprivateendpointpricingrequest.mdx | 10 +- .../updateprivateendpointrequest.mdx | 10 +- .../updatescimgroupmappingglobals.mdx | 6 +- .../updatescimgroupmappingrequest.mdx | 10 +- docs/operations/updateworkspaceglobals.mdx | 6 +- docs/operations/updateworkspacerequest.mdx | 10 +- docs/operations/uploadfilefile.mdx | 6 +- docs/operations/uploadfileglobals.mdx | 6 +- docs/operations/uploadfilerequest.mdx | 12 +- docs/operations/uploadfilerequestbody.mdx | 2 +- .../upsertworkspacebudgetglobals.mdx | 6 +- .../upsertworkspacebudgetrequest.mdx | 12 +- .../validateprivateendpointglobals.mdx | 6 +- .../validateprivateendpointrequest.mdx | 10 +- docs/sdks/analytics/README.mdx | 40 +-- docs/sdks/apikeys/README.mdx | 90 +++--- docs/sdks/batch/README.mdx | 56 ++-- docs/sdks/benchmarks/README.mdx | 26 +- docs/sdks/betaresponses/README.mdx | 88 +++--- docs/sdks/byok/README.mdx | 102 +++--- docs/sdks/chat/README.mdx | 94 +++--- docs/sdks/classifications/README.mdx | 10 +- docs/sdks/containers/README.mdx | 50 +-- docs/sdks/credits/README.mdx | 8 +- docs/sdks/datasets/README.mdx | 62 ++-- docs/sdks/decisions/README.mdx | 24 +- docs/sdks/embeddings/README.mdx | 38 +-- docs/sdks/endpoints/README.mdx | 20 +- docs/sdks/endusers/README.mdx | 58 ++-- docs/sdks/files/README.mdx | 80 ++--- docs/sdks/generations/README.mdx | 34 +- docs/sdks/guardrails/README.mdx | 240 +++++++------- docs/sdks/images/README.mdx | 62 ++-- docs/sdks/interns/README.mdx | 182 +++++------ docs/sdks/models/README.mdx | 104 +++--- docs/sdks/oauth/README.mdx | 66 ++-- docs/sdks/observability/README.mdx | 104 +++--- docs/sdks/organization/README.mdx | 30 +- docs/sdks/presets/README.mdx | 296 +++++++++--------- docs/sdks/privateendpoints/README.mdx | 128 ++++---- docs/sdks/providers/README.mdx | 8 +- docs/sdks/rerank/README.mdx | 24 +- docs/sdks/responses/README.mdx | 88 +++--- docs/sdks/scim/README.mdx | 94 +++--- docs/sdks/stt/README.mdx | 66 ++-- docs/sdks/systemone/README.mdx | 22 +- docs/sdks/tools/README.mdx | 28 +- docs/sdks/tts/README.mdx | 30 +- docs/sdks/vault/README.mdx | 104 +++--- docs/sdks/videogeneration/README.mdx | 74 ++--- docs/sdks/workspaces/README.mdx | 188 +++++------ pyproject.toml | 2 +- src/openrouter/_version.py | 4 +- .../components/createguardrailrequest.py | 7 + src/openrouter/components/guardrail.py | 7 + src/openrouter/components/speechinput.py | 4 +- src/openrouter/components/speechrequest.py | 8 +- .../components/updateguardrailrequest.py | 7 + src/openrouter/guardrails.py | 12 + src/openrouter/tts.py | 8 +- uv.lock | 2 +- 1468 files changed, 8017 insertions(+), 7951 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index dd9b826cb..58ac703ff 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,19 +1,19 @@ lockVersion: 2.0.0 id: c48cf606-fb42-4a45-9c23-8f0555307828 management: - docChecksum: 1840154f84c770bcfaac5d64913c1fd6 + docChecksum: 74a9498efb41dcdc19f8858f4658169d docVersion: 1.0.0 speakeasyVersion: 1.787.0 generationVersion: 2.914.0 - releaseVersion: 1.3.45 - configChecksum: c29e3485096466a2dffee9816463f33b + releaseVersion: 1.3.46 + configChecksum: 141159e444382b0c125fa2b6a8fd798c repoURL: https://github.com/OpenRouterTeam/python-sdk.git installationURL: https://github.com/OpenRouterTeam/python-sdk.git published: true persistentEdits: - generation_id: 4a832f93-aec4-4832-bed6-d4ff565b7347 - pristine_commit_hash: afca828bee1b526d94a954bf47f188c9ef49c6ce - pristine_tree_hash: a4c1825fca598c3582dc3009bbb4e05778824cc6 + generation_id: 404c369a-769d-4cce-be8f-4439f1911bbb + pristine_commit_hash: e265fdf99a06176f920163b2163367a75c10684c + pristine_tree_hash: 9572ea873592996bd1755d1f82ffe15d96dc2593 features: python: acceptHeaders: 3.0.0 @@ -2508,8 +2508,8 @@ trackedFiles: pristine_git_object: 9d28e4c7e863cf97b10b6415b1525aa8871800e2 docs/components/createguardrailrequest.mdx: id: c1a768f054c0 - last_write_checksum: sha1:d32d712d132971b34f6d81d28ff45d22d919f4ac - pristine_git_object: 3930d118781a8fbb7efdc3e347f99773828097ca + last_write_checksum: sha1:cea8928fa2aa97f9d157a6c0fbee5b6d8a8ce29e + pristine_git_object: fbc52a249c5fe348cc05e7597bfe3e0fe77d89b4 docs/components/createguardrailresponse.mdx: id: 1477eebdf505 last_write_checksum: sha1:76bb1fcafda689e9823bb21541c84e7d0bdb991d @@ -3432,8 +3432,8 @@ trackedFiles: pristine_git_object: 6e17644dffb3aef799758f46d5ac781114b58c1f docs/components/guardrail.mdx: id: 91791d4c83b6 - last_write_checksum: sha1:6f8af0e14ef12e99132304a903cc2e68adff68a0 - pristine_git_object: 884c23302a2aa375a053e84bd702aa3b9e76595d + last_write_checksum: sha1:9b469e162e9f0e8cece5ff0d328ac0c70b66506a + pristine_git_object: 2f0f384b3ed628f4f4d15f4e3cc461f6808b0d58 docs/components/guardraildataregion.mdx: id: d3be2a48aa20 last_write_checksum: sha1:81f1c0b515e1c1c13432cae9910ce77cb9991507 @@ -6892,8 +6892,8 @@ trackedFiles: pristine_git_object: 5d617cac37f7b364f4dd0640246e97c34351d824 docs/components/speechinput.mdx: id: 663248d32888 - last_write_checksum: sha1:a8126cfb9764e1cd97fd896dedc4f40f7ab441bb - pristine_git_object: 948ee8455aede1f95245b7bfe33d04c293576edd + last_write_checksum: sha1:3ac2a504a301aedde4842c0a76ea324871c6b1af + pristine_git_object: 45150512fd74a6d8fa935b9867c4877b1f0d5916 docs/components/speechinputreference.mdx: id: eb5af16936c7 last_write_checksum: sha1:ab545b03da2161ae1ad449714b6861cd55ae66df @@ -6932,8 +6932,8 @@ trackedFiles: pristine_git_object: 34f4f07fb3008df83646fa3d88ce04009274246a docs/components/speechrequest.mdx: id: 06e81b0433f6 - last_write_checksum: sha1:ecac6988ab27bf129f774f3982e36744ec613218 - pristine_git_object: c538a0061028cbaae17210def2258da7316b07e7 + last_write_checksum: sha1:c2a048132db0ccec0c3b5b59ab52a78a49e83e29 + pristine_git_object: e87bc0ab286848af07a53d51097ccdb5088ead6c docs/components/speechrequestdatacollection.mdx: id: 6c5938568888 last_write_checksum: sha1:89a08b4c4de66c1ef7676792a38747e030ed6729 @@ -7696,8 +7696,8 @@ trackedFiles: pristine_git_object: 72a1c5ade4703a295e533f6e12733f464a21ff65 docs/components/updateguardrailrequest.mdx: id: 450912b18db6 - last_write_checksum: sha1:f0e2aaf8ecb96d8b53a02768ec260472490963cd - pristine_git_object: e42e435d516b5fb62183b7e0a65e20bdbcf25f1b + last_write_checksum: sha1:4f48f8b6eca22b5e1ea96814aa9a642655589755 + pristine_git_object: dfd991a99fdac0b0076405d3ba2233d9ecf3cc52 docs/components/updateguardrailresponse.mdx: id: e00dc0a0c6e0 last_write_checksum: sha1:1be70185072640936151f861913c2b89a09d4bab @@ -10088,8 +10088,8 @@ trackedFiles: pristine_git_object: bc1a56cbb41c8f9114c81b547713632272184da6 docs/sdks/guardrails/README.mdx: id: a0cd4218b8fa - last_write_checksum: sha1:5d726806705c8c06aa1df8ecbebfa04a0214d8d4 - pristine_git_object: d419fd3ee53c199c96b5228f7b656fa8e732bd69 + last_write_checksum: sha1:a5ca6ada43eb3b8cdb6c29ed2c1be2a8663a5600 + pristine_git_object: 6fbf9985e512ede6ae14dedcfa421c5b5338ef4f docs/sdks/images/README.mdx: id: 534a6c102c4f last_write_checksum: sha1:82a8bd22fb399fe419076afe29b9234950baf9f9 @@ -10152,8 +10152,8 @@ trackedFiles: pristine_git_object: 1dd30f0b898f2a842d1bb585b03d887be90e7845 docs/sdks/tts/README.mdx: id: cd1132543884 - last_write_checksum: sha1:cb9303bf791d8d9784be2815fae45f4b09f82221 - pristine_git_object: b96e9d3ee1f40340dcd002a717920f7576b9fe3f + last_write_checksum: sha1:baa3374d9c06310a87893eb14a25511de061f3dc + pristine_git_object: 7b3c78a7323028a4668d6ce8394c8cdd4c15b67d docs/sdks/vault/README.mdx: id: 3738c6722acd last_write_checksum: sha1:12acdfed4c2a32488d98b6091fd8c392af516494 @@ -10172,8 +10172,8 @@ trackedFiles: pristine_git_object: 3e38f1a929f7d6b1d6de74604aa87e3d8f010544 pyproject.toml: id: 5d07e7d72637 - last_write_checksum: sha1:bfc195206e429a0afdf9b31b204291cd59cf2e3b - pristine_git_object: 89e32936fd2dfc18e5348ea54d2b3de267258e85 + last_write_checksum: sha1:3a7148e3325f6ae7604aec17d8cf09b6871117a2 + pristine_git_object: 951c4e488ab00fa2ca68fd1226f382e44e225576 scripts/prepare_readme.py: id: e0c5957a6035 last_write_checksum: sha1:77f44b60b98bc126557ec27391f91dfba764bb54 @@ -10200,8 +10200,8 @@ trackedFiles: pristine_git_object: 86713cfea633e09d33b3d4e65281071fe20e6137 src/openrouter/_version.py: id: d8d15ad6c586 - last_write_checksum: sha1:b192be1c2491a7fb42f7092a4a00748ba1f8a9f4 - pristine_git_object: d1c45a6fa71a7a62db5c7e2bb68df374a7f61565 + last_write_checksum: sha1:4bf11cf5cf55b3b9a3928b6ccbebc1bfb4b3cf67 + pristine_git_object: 8022b124ae2919285f485ab56f62a5268b751705 src/openrouter/alpha.py: id: 306c4d93308d last_write_checksum: sha1:30f55a360f41376ab194b9ea725fe4e001a5ae1a @@ -11308,8 +11308,8 @@ trackedFiles: pristine_git_object: be0ce3784071a98e96fe996eb9da24455af72ac8 src/openrouter/components/createguardrailrequest.py: id: 34d69149fb33 - last_write_checksum: sha1:af6fca661fed3b42e547333b14750448c46b43cf - pristine_git_object: d3cb25c2acff7aa00ad2cd966e5aaeb62d6e531c + last_write_checksum: sha1:68757e5b5d1f5f2a5ff07d8dc460032321e49b21 + pristine_git_object: 77ce30da985f3a890aaadca0cefdf7492d011074 src/openrouter/components/createguardrailresponse.py: id: b4e1bdf1de5b last_write_checksum: sha1:ae20a5e7425510c240e5697d847b1cae65940bd6 @@ -11740,8 +11740,8 @@ trackedFiles: pristine_git_object: 1268e32c9058ed4feb7482458a64366c56201676 src/openrouter/components/guardrail.py: id: 67ee78dd06e6 - last_write_checksum: sha1:a06d7d1d1aa75b2e1c27cfa10cc5347a88821e76 - pristine_git_object: c58c4908937be5ceb0414666315782ebb862e331 + last_write_checksum: sha1:062a4f1c5ad066e1da29856f5dce1b5ba60b0c3c + pristine_git_object: 60bef2177a15cc42ade160dca9b4933ecdce6ecb src/openrouter/components/guardraildataregion.py: id: 16c31f1446b2 last_write_checksum: sha1:52b5622a7c93a30219108f033ab0e3fbb3a396f7 @@ -13156,8 +13156,8 @@ trackedFiles: pristine_git_object: e44305da959380e177fcc2077d0e80ce4d522a57 src/openrouter/components/speechinput.py: id: 14e46bea4b32 - last_write_checksum: sha1:4f2acbfbb0b8df5d8d2d3916f9a081a6143fdf45 - pristine_git_object: 676f38928a4745ddb215cb8275c401e6fb5ebc25 + last_write_checksum: sha1:c6e320441ce7eaa95072d8796e97f082302bb326 + pristine_git_object: e85b5d8efbe123f41f4006b0e74ee5894da3fdc2 src/openrouter/components/speechinputreference.py: id: 8e2b63f83354 last_write_checksum: sha1:b2ebc68fae64644f8bfca9b555ca7d2a7b46c9e1 @@ -13184,8 +13184,8 @@ trackedFiles: pristine_git_object: 4633e5d7658c500aa903ce8caa8ef86cc97b78eb src/openrouter/components/speechrequest.py: id: 2a9400167112 - last_write_checksum: sha1:49cbabd40418cc50b15e7eef19926ce55be23a4e - pristine_git_object: ad116652ee8ead569fb0939c29c6966bb397717e + last_write_checksum: sha1:5bfcf28dde5e94e671165f5919e24b3b9de83853 + pristine_git_object: ea07e4017cdd9b909f84129e83c0582c7effe10a src/openrouter/components/speechturn.py: id: 121e0a940f91 last_write_checksum: sha1:31bdba00e027b81de8a3872d48e694475cf02e7a @@ -13456,8 +13456,8 @@ trackedFiles: pristine_git_object: 0a8dcb3fb8d9c0c80159a622246dff4a3110bb1b src/openrouter/components/updateguardrailrequest.py: id: 6a557cd822a0 - last_write_checksum: sha1:0e5978b49b7a37f48931dd778caf1fc46657b881 - pristine_git_object: 21afa8a30b9688294c7c210ed45e23ea17109241 + last_write_checksum: sha1:0894e7041ba0f23258b1234428049f20c4ea3500 + pristine_git_object: 17311e522a8109c9c9c99808f0701da0df389ce5 src/openrouter/components/updateguardrailresponse.py: id: 7b068d26ce31 last_write_checksum: sha1:2b63cbb90747f07f775d9a22e80f74c67221fea8 @@ -13824,8 +13824,8 @@ trackedFiles: pristine_git_object: 5698c384a36929846530cae98f69ce83a0966217 src/openrouter/guardrails.py: id: 705839f34e66 - last_write_checksum: sha1:1551845b6a9776480d99ef0fc1fca61e845f3de2 - pristine_git_object: 785964ad30a2043c9d70272f15d1a3fac9635b73 + last_write_checksum: sha1:4771ac29e1010c57efa8bf7ead0a4bcef18552e6 + pristine_git_object: f615049517074fbcc71b755e351efda8411810aa src/openrouter/httpclient.py: id: e9311185443d last_write_checksum: sha1:5e55338d6ee9f01ab648cad4380201a8a3da7dd7 @@ -14520,8 +14520,8 @@ trackedFiles: pristine_git_object: 701fa8597ff85f41a60736ade55fcb32f9ec7125 src/openrouter/tts.py: id: 5055d4b95f1d - last_write_checksum: sha1:9826552c18767897c4dc6c3cd8c2ce41da40a344 - pristine_git_object: 5b1bf2a61bfd3d476284465192603aa7d90adfd7 + last_write_checksum: sha1:93fae27a87035c17b86c6e5353754c371c9c3faa + pristine_git_object: 001335f1dc471131bca2c942ea98c67825c7921f src/openrouter/types/__init__.py: id: 5eab536205b7 last_write_checksum: sha1:f9ad14217f832e74f594285960125add50324be9 @@ -18576,4 +18576,4 @@ examples: "500": application/json: {"error": {"code": 404, "message": "Intern not found"}} examplesVersion: 1.0.2 -releaseNotes: "## Python SDK Changes:\n* `open_router.observability.list()`: `response.data[]` **Changed**\n* `open_router.observability.create()`: \n * `request.broadcast_generation_cost_allocation` **Added**\n * `response.data` **Changed**\n* `open_router.observability.get()`: `response.data` **Changed**\n* `open_router.observability.update()`: \n * `request.broadcast_generation_cost_allocation` **Added**\n * `response.data` **Changed**\n" +releaseNotes: "## Python SDK Changes:\n* `open_router.guardrails.list()`: `response.data[].allow_safety_retention_google` **Added**\n* `open_router.guardrails.create()`: \n * `request.allow_safety_retention_google` **Added**\n * `response.data.allow_safety_retention_google` **Added**\n* `open_router.guardrails.get()`: `response.data.allow_safety_retention_google` **Added**\n* `open_router.guardrails.update()`: \n * `request.allow_safety_retention_google` **Added**\n * `response.data.allow_safety_retention_google` **Added**\n" diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index c102eb1c6..3e9a3f02d 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -36,7 +36,7 @@ generation: documentation: mintlify preApplyUnionDiscriminators: true python: - version: 1.3.45 + version: 1.3.46 additionalDependencies: dev: {} main: {} diff --git a/.speakeasy/out.openapi.yaml b/.speakeasy/out.openapi.yaml index e34363de2..e681d8535 100644 --- a/.speakeasy/out.openapi.yaml +++ b/.speakeasy/out.openapi.yaml @@ -9470,6 +9470,12 @@ components: name: 'My New Guardrail' reset_interval: 'monthly' properties: + allow_safety_retention_google: + description: 'Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided.' + example: true + type: + - 'boolean' + - 'null' allowed_data_regions: description: '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.' example: @@ -13147,6 +13153,12 @@ components: updated_at: '2025-08-24T15:45:00Z' workspace_id: '0df9e665-d932-5740-b2c7-b52af166bc11' properties: + allow_safety_retention_google: + description: 'Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided.' + example: true + type: + - 'boolean' + - 'null' allowed_data_regions: description: '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.' example: @@ -29393,7 +29405,7 @@ components: $ref: '#/components/schemas/SpeechTurn' minItems: 1 type: 'array' - description: '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.' + description: '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 supported by Gemini TTS models and by Fish Audio models other than S1.' example: 'Hello world' SpeechInputReference: description: 'Reference content part for stateless voice cloning or voice design' @@ -29515,7 +29527,7 @@ components: $ref: '#/components/schemas/SpeechInputReference' type: 'array' instructions: - description: '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.' + description: 'Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers.' example: 'Speak in a warm and friendly tone.' type: 'string' model: @@ -32011,6 +32023,12 @@ components: name: 'Updated Guardrail Name' reset_interval: 'weekly' properties: + allow_safety_retention_google: + description: 'Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided.' + example: false + type: + - 'boolean' + - 'null' allowed_data_regions: description: '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.' example: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index c517c0c0b..f67178e96 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:83dd501cffdaf07564432a2f54ad8c9fcfb9263e1d1cc5303a2415a8aa507013 - sourceBlobDigest: sha256:e9cd324070275762af8716aad68250a323479419f57ce6ce70cd1d74f9a27fe7 + sourceRevisionDigest: sha256:de5eab99c6123c08b364e967487823545df9a1fe5c2a2ce0678ebf4e116abca9 + sourceBlobDigest: sha256:11101d2d34fa1e9d2006637fab5215e8cd2c9d0917bde662bd78a7b5a4c75c44 tags: - latest - 1.0.0 @@ -11,10 +11,10 @@ targets: open-router: source: OpenRouter API sourceNamespace: open-router-chat-completions-api - sourceRevisionDigest: sha256:83dd501cffdaf07564432a2f54ad8c9fcfb9263e1d1cc5303a2415a8aa507013 - sourceBlobDigest: sha256:e9cd324070275762af8716aad68250a323479419f57ce6ce70cd1d74f9a27fe7 + sourceRevisionDigest: sha256:de5eab99c6123c08b364e967487823545df9a1fe5c2a2ce0678ebf4e116abca9 + sourceBlobDigest: sha256:11101d2d34fa1e9d2006637fab5215e8cd2c9d0917bde662bd78a7b5a4c75c44 codeSamplesNamespace: open-router-python-code-samples - codeSamplesRevisionDigest: sha256:15e4f11f490017daa064d07e157162165ff717b9f2b1b07dbbaa2526b1d576db + codeSamplesRevisionDigest: sha256:4f0e18ce320b7957dfa9ed66a7d40776302827786ef1dc369ddfc5be3c406ab1 workflow: workflowVersion: 1.0.0 speakeasyVersion: 1.787.0 diff --git a/RELEASES.md b/RELEASES.md index 41d836a59..e1fb7d743 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -3219,4 +3219,14 @@ Based on: ### Generated - [python v1.3.45] . ### Releases -- [PyPI v1.3.45] https://pypi.org/project/openrouter/1.3.45 - . \ No newline at end of file +- [PyPI v1.3.45] https://pypi.org/project/openrouter/1.3.45 - . + +## 2026-10-13 19:32:42 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.3.46] . +### Releases +- [PyPI v1.3.46] https://pypi.org/project/openrouter/1.3.46 - . \ No newline at end of file diff --git a/docs/components/aabenchmarkentry.mdx b/docs/components/aabenchmarkentry.mdx index b99de065c..172d96463 100644 --- a/docs/components/aabenchmarkentry.mdx +++ b/docs/components/aabenchmarkentry.mdx @@ -9,6 +9,6 @@ Artificial Analysis benchmark index scores. | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `agentic_index` | *Nullable[float]* | ✅ | Artificial Analysis Agentic Index score | 55.8 | -| `coding_index` | *Nullable[float]* | ✅ | Artificial Analysis Coding Index score | 63.2 | -| `intelligence_index` | *Nullable[float]* | ✅ | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file +| `agentic_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Agentic Index score | 55.8 | +| `coding_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Coding Index score | 63.2 | +| `intelligence_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file diff --git a/docs/components/activityitem.mdx b/docs/components/activityitem.mdx index 753fb04e4..c18a6d10b 100644 --- a/docs/components/activityitem.mdx +++ b/docs/components/activityitem.mdx @@ -6,16 +6,16 @@ title: "ActivityItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage_inference` | *float* | ✅ | BYOK inference cost in USD (external credits spent) | 0.012 | -| `cached_tokens` | *int* | ✅ | 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 | -| `completion_tokens` | *int* | ✅ | Total completion tokens generated | 125 | -| `date_` | *str* | ✅ | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `endpoint_id` | *str* | ✅ | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `model` | *str* | ✅ | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `model_permaslug` | *str* | ✅ | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `prompt_tokens` | *int* | ✅ | Total prompt tokens used | 50 | -| `provider_name` | *str* | ✅ | Name of the provider serving this endpoint | OpenAI | -| `reasoning_tokens` | *int* | ✅ | Total reasoning tokens used | 25 | -| `requests` | *int* | ✅ | Number of requests made | 5 | -| `usage` | *float* | ✅ | Total cost in USD (OpenRouter credits spent) | 0.015 | -| `workspace_id` | *Optional[str]* | ➖ | 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 +| `byok_usage_inference` | *float* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | +| `cached_tokens` | *int* | :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 | +| `completion_tokens` | *int* | :heavy_check_mark: | Total completion tokens generated | 125 | +| `date_` | *str* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | +| `endpoint_id` | *str* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | +| `model` | *str* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | +| `model_permaslug` | *str* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | +| `prompt_tokens` | *int* | :heavy_check_mark: | Total prompt tokens used | 50 | +| `provider_name` | *str* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | +| `reasoning_tokens` | *int* | :heavy_check_mark: | Total reasoning tokens used | 25 | +| `requests` | *int* | :heavy_check_mark: | Number of requests made | 5 | +| `usage` | *float* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | +| `workspace_id` | *Optional[str]* | :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/components/activityresponse.mdx b/docs/components/activityresponse.mdx index 6f16edc18..6edb98e87 100644 --- a/docs/components/activityresponse.mdx +++ b/docs/components/activityresponse.mdx @@ -6,4 +6,4 @@ title: "ActivityResponse" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `data` | List[[components.ActivityItem](../components/activityitem.mdx)] | ✅ | List of activity items | \ No newline at end of file +| `data` | List[[components.ActivityItem](../components/activityitem.mdx)] | :heavy_check_mark: | List of activity items | \ No newline at end of file diff --git a/docs/components/additionaltoolsitem.mdx b/docs/components/additionaltoolsitem.mdx index 3939b384a..34d2291ed 100644 --- a/docs/components/additionaltoolsitem.mdx +++ b/docs/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[str]* | ➖ | N/A | -| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole.mdx) | ✅ | N/A | -| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion.mdx)] | ✅ | N/A | -| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools.mdx) | ✅ | N/A | \ No newline at end of file +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A | +| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion.mdx)] | :heavy_check_mark: | N/A | +| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/additionaltoolsitemtool.mdx b/docs/components/additionaltoolsitemtool.mdx index 5659c3ab6..129b2fdfb 100644 --- a/docs/components/additionaltoolsitemtool.mdx +++ b/docs/components/additionaltoolsitemtool.mdx @@ -6,5 +6,5 @@ title: "AdditionalToolsItemTool" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `type` | *str* | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/additionaltoolsitemtoolfunction.mdx b/docs/components/additionaltoolsitemtoolfunction.mdx index fdf393ba9..842c06ca1 100644 --- a/docs/components/additionaltoolsitemtoolfunction.mdx +++ b/docs/components/additionaltoolsitemtoolfunction.mdx @@ -9,12 +9,12 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `parameters` | Dict[str, *Any*] | ✅ | N/A | | -| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | -| `type` | [components.AdditionalToolsItemTypeFunction](../components/additionaltoolsitemtypefunction.mdx) | ✅ | N/A | | -| `allowed_callers` | List[[components.AdditionalToolsItemAllowedCaller](../components/additionaltoolsitemallowedcaller.mdx)] | ➖ | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | -| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | \ No newline at end of file +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `parameters` | Dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `type` | [components.AdditionalToolsItemTypeFunction](../components/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A | | +| `allowed_callers` | List[[components.AdditionalToolsItemAllowedCaller](../components/additionaltoolsitemallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | +| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/advisorreasoning.mdx b/docs/components/advisorreasoning.mdx index fe99b3c61..b33ef5366 100644 --- a/docs/components/advisorreasoning.mdx +++ b/docs/components/advisorreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the advisor call. Use this to control reaso | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `effort` | [Optional[components.AdvisorReasoningEffort]](../components/advisorreasoningeffort.mdx) | ➖ | Reasoning effort level for the advisor call. | -| `max_tokens` | *Optional[int]* | ➖ | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file +| `effort` | [Optional[components.AdvisorReasoningEffort]](../components/advisorreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the advisor call. | +| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file diff --git a/docs/components/advisorservertoolconfig.mdx b/docs/components/advisorservertoolconfig.mdx index 7e506a3af..5aa0ee10c 100644 --- a/docs/components/advisorservertoolconfig.mdx +++ b/docs/components/advisorservertoolconfig.mdx @@ -9,11 +9,11 @@ Configuration for one openrouter:advisor server tool entry. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `forward_transcript` | *Optional[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` | *Optional[str]* | ➖ | 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. | -| `max_completion_tokens` | *Optional[int]* | ➖ | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | -| `model` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.AdvisorReasoning]](../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` | *Optional[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` | *Optional[float]* | ➖ | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file +| `forward_transcript` | *Optional[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` | *Optional[str]* | :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. | +| `max_completion_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | +| `model` | *Optional[str]* | :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` | *Optional[str]* | :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` | [Optional[components.AdvisorReasoning]](../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` | *Optional[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` | *Optional[float]* | :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/components/advisorservertoolopenrouter.mdx b/docs/components/advisorservertoolopenrouter.mdx index 5854fc0a5..3c141ae51 100644 --- a/docs/components/advisorservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.AdvisorServerToolConfig]](../components/advisorservertoolconfig.mdx) | ➖ | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | -| `type` | [components.AdvisorServerToolOpenRouterType](../components/advisorservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.AdvisorServerToolConfig]](../components/advisorservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | +| `type` | [components.AdvisorServerToolOpenRouterType](../components/advisorservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/agent.mdx b/docs/components/agent.mdx index 11f9405f8..198da9e83 100644 --- a/docs/components/agent.mdx +++ b/docs/components/agent.mdx @@ -6,5 +6,5 @@ title: "Agent" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `agent_name` | *str* | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `agent_name` | *str* | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/agentmessageitem.mdx b/docs/components/agentmessageitem.mdx index 229ca2345..6c75e26dd 100644 --- a/docs/components/agentmessageitem.mdx +++ b/docs/components/agentmessageitem.mdx @@ -9,10 +9,10 @@ A message routed between agents in a multi-agent session | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `agent` | [OptionalNullable[components.Agent]](../components/agent.mdx) | ➖ | N/A | | -| `author` | *str* | ✅ | N/A | | -| `content` | List[[components.AgentMessageItemContentUnion](../components/agentmessageitemcontentunion.mdx)] | ✅ | N/A | | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `recipient` | *str* | ✅ | N/A | | -| `type` | [components.TypeAgentMessage](../components/typeagentmessage.mdx) | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *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[components.Agent]](../components/agent.mdx) | :heavy_minus_sign: | N/A | | +| `author` | *str* | :heavy_check_mark: | N/A | | +| `content` | List[[components.AgentMessageItemContentUnion](../components/agentmessageitemcontentunion.mdx)] | :heavy_check_mark: | N/A | | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `recipient` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.TypeAgentMessage](../components/typeagentmessage.mdx) | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/agentmessageitemcontentinputimage.mdx b/docs/components/agentmessageitemcontentinputimage.mdx index 412ca03f4..94ab47b17 100644 --- a/docs/components/agentmessageitemcontentinputimage.mdx +++ b/docs/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](../components/agentmessageitemdetail.mdx) | ✅ | N/A | -| `file_id` | *OptionalNullable[str]* | ➖ | N/A | -| `image_url` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.AgentMessageItemTypeInputImage](../components/agentmessageitemtypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file +| `detail` | [components.AgentMessageItemDetail](../components/agentmessageitemdetail.mdx) | :heavy_check_mark: | N/A | +| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.AgentMessageItemTypeInputImage](../components/agentmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/alignment.mdx b/docs/components/alignment.mdx index 4766f1b53..112c870ba 100644 --- a/docs/components/alignment.mdx +++ b/docs/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` | List[[components.AlignmentCallRecord](../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` | List[[components.AlignmentCallRecord](../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/components/alignmentallowedcallrecord.mdx b/docs/components/alignmentallowedcallrecord.mdx index 289916bfa..312b5ea4a 100644 --- a/docs/components/alignmentallowedcallrecord.mdx +++ b/docs/components/alignmentallowedcallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentAllowedCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call` | *int* | ✅ | 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](../components/alignmentallowedcallrecordoutcome.mdx) | ✅ | N/A | -| `rules` | List[[components.AlignmentRuleRecord](../components/alignmentrulerecord.mdx)] | ✅ | One record per rule, in the order of `rules` in the request. | \ No newline at end of file +| `call` | *int* | :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](../components/alignmentallowedcallrecordoutcome.mdx) | :heavy_check_mark: | N/A | +| `rules` | List[[components.AlignmentRuleRecord](../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/components/alignmentblockedcallrecord.mdx b/docs/components/alignmentblockedcallrecord.mdx index 60bcf2b73..95e38c650 100644 --- a/docs/components/alignmentblockedcallrecord.mdx +++ b/docs/components/alignmentblockedcallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentBlockedCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call` | *int* | ✅ | 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](../components/alignmentblockedcallrecordoutcome.mdx) | ✅ | N/A | -| `rules` | List[[components.AlignmentRuleRecord](../components/alignmentrulerecord.mdx)] | ✅ | One record per rule, in the order of `rules` in the request. | \ No newline at end of file +| `call` | *int* | :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](../components/alignmentblockedcallrecordoutcome.mdx) | :heavy_check_mark: | N/A | +| `rules` | List[[components.AlignmentRuleRecord](../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/components/alignmentchataudio.mdx b/docs/components/alignmentchataudio.mdx index 20f46d2fb..891393b74 100644 --- a/docs/components/alignmentchataudio.mdx +++ b/docs/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` | *Optional[str]* | ➖ | The provider id of the audio. | -| `transcript` | *str* | ✅ | The transcript of the audio. | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_minus_sign: | The provider id of the audio. | +| `transcript` | *str* | :heavy_check_mark: | The transcript of the audio. | \ No newline at end of file diff --git a/docs/components/alignmentchatimage.mdx b/docs/components/alignmentchatimage.mdx index fa9039dcf..f44d4af7a 100644 --- a/docs/components/alignmentchatimage.mdx +++ b/docs/components/alignmentchatimage.mdx @@ -6,5 +6,5 @@ title: "AlignmentChatImage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `image_url` | [components.AlignmentChatImageImageURL](../components/alignmentchatimageimageurl.mdx) | ✅ | N/A | -| `type` | [components.AlignmentChatImageType](../components/alignmentchatimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `image_url` | [components.AlignmentChatImageImageURL](../components/alignmentchatimageimageurl.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.AlignmentChatImageType](../components/alignmentchatimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/alignmentchatimageimageurl.mdx b/docs/components/alignmentchatimageimageurl.mdx index 4c98024c4..c5f4fff07 100644 --- a/docs/components/alignmentchatimageimageurl.mdx +++ b/docs/components/alignmentchatimageimageurl.mdx @@ -6,4 +6,4 @@ title: "AlignmentChatImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/alignmentchatrejected.mdx b/docs/components/alignmentchatrejected.mdx index bb6fdc1b9..6210da6a6 100644 --- a/docs/components/alignmentchatrejected.mdx +++ b/docs/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` | [Optional[components.AlignmentChatAudio]](../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` | *Nullable[str]* | ✅ | N/A | | -| `images` | List[[components.AlignmentChatImage](../components/alignmentchatimage.mdx)] | ➖ | N/A | | -| `refusal` | *Nullable[str]* | ✅ | N/A | | -| `role` | [components.AlignmentChatRejectedRole](../components/alignmentchatrejectedrole.mdx) | ✅ | N/A | | -| `tool_calls` | List[[components.AlignmentChatToolCall](../components/alignmentchattoolcall.mdx)] | ➖ | N/A | | \ No newline at end of file +| `audio` | [Optional[components.AlignmentChatAudio]](../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` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `images` | List[[components.AlignmentChatImage](../components/alignmentchatimage.mdx)] | :heavy_minus_sign: | N/A | | +| `refusal` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `role` | [components.AlignmentChatRejectedRole](../components/alignmentchatrejectedrole.mdx) | :heavy_check_mark: | N/A | | +| `tool_calls` | List[[components.AlignmentChatToolCall](../components/alignmentchattoolcall.mdx)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/alignmentchattoolcall.mdx b/docs/components/alignmentchattoolcall.mdx index 1889a1362..265c22b70 100644 --- a/docs/components/alignmentchattoolcall.mdx +++ b/docs/components/alignmentchattoolcall.mdx @@ -6,6 +6,6 @@ title: "AlignmentChatToolCall" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `function` | [components.AlignmentChatToolCallFunction](../components/alignmentchattoolcallfunction.mdx) | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `type` | [components.AlignmentChatToolCallType](../components/alignmentchattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file +| `function` | [components.AlignmentChatToolCallFunction](../components/alignmentchattoolcallfunction.mdx) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AlignmentChatToolCallType](../components/alignmentchattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/alignmentchattoolcallfunction.mdx b/docs/components/alignmentchattoolcallfunction.mdx index 40ad8af96..ef02a544e 100644 --- a/docs/components/alignmentchattoolcallfunction.mdx +++ b/docs/components/alignmentchattoolcallfunction.mdx @@ -6,5 +6,5 @@ title: "AlignmentChatToolCallFunction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `arguments` | *str* | ✅ | N/A | -| `name` | *str* | ✅ | N/A | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/alignmentplugin.mdx b/docs/components/alignmentplugin.mdx index 52acaa0ea..0c01e3d04 100644 --- a/docs/components/alignmentplugin.mdx +++ b/docs/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](../components/alignmentpluginid.mdx) | ✅ | N/A | | -| `instruct` | *Optional[bool]* | ➖ | Whether the rules are stated to the model in a system message on every provider call. Default true. | | -| `max_retries` | *Optional[int]* | ➖ | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | -| `mode` | [Optional[components.AlignmentPluginMode]](../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` | List[*str*] | ✅ | 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` | *Optional[float]* | ➖ | Probability at or above which a rule is broken. Default 0.7. | | \ No newline at end of file +| `id` | [components.AlignmentPluginID](../components/alignmentpluginid.mdx) | :heavy_check_mark: | N/A | | +| `instruct` | *Optional[bool]* | :heavy_minus_sign: | Whether the rules are stated to the model in a system message on every provider call. Default true. | | +| `max_retries` | *Optional[int]* | :heavy_minus_sign: | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | +| `mode` | [Optional[components.AlignmentPluginMode]](../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` | List[*str*] | :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` | *Optional[float]* | :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/components/alignmentrulerecord.mdx b/docs/components/alignmentrulerecord.mdx index 76971e467..74a00b060 100644 --- a/docs/components/alignmentrulerecord.mdx +++ b/docs/components/alignmentrulerecord.mdx @@ -6,5 +6,5 @@ title: "AlignmentRuleRecord" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `broken` | *bool* | ✅ | Whether probability is at or above the threshold. | -| `probability` | *float* | ✅ | 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` | *float* | :heavy_check_mark: | The evaluator's probability that the turn breaks the rule. | \ No newline at end of file diff --git a/docs/components/alignmentunavailablecallrecord.mdx b/docs/components/alignmentunavailablecallrecord.mdx index ed3097b0c..cd46fe478 100644 --- a/docs/components/alignmentunavailablecallrecord.mdx +++ b/docs/components/alignmentunavailablecallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentUnavailableCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call` | *int* | ✅ | 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](../components/alignmentunavailablecallrecordoutcome.mdx) | ✅ | N/A | -| `reason` | [components.AlignmentUnavailableCallRecordReason](../components/alignmentunavailablecallrecordreason.mdx) | ✅ | N/A | \ No newline at end of file +| `call` | *int* | :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](../components/alignmentunavailablecallrecordoutcome.mdx) | :heavy_check_mark: | N/A | +| `reason` | [components.AlignmentUnavailableCallRecordReason](../components/alignmentunavailablecallrecordreason.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/allowedtools.mdx b/docs/components/allowedtools.mdx index fa714f9e6..14377fe6a 100644 --- a/docs/components/allowedtools.mdx +++ b/docs/components/allowedtools.mdx @@ -6,5 +6,5 @@ title: "AllowedTools" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `read_only` | *Optional[bool]* | ➖ | N/A | -| `tool_names` | List[*str*] | ➖ | N/A | \ No newline at end of file +| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/always.mdx b/docs/components/always.mdx index 7be3d5420..539af0bb9 100644 --- a/docs/components/always.mdx +++ b/docs/components/always.mdx @@ -6,4 +6,4 @@ title: "Always" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `tool_names` | List[*str*] | ➖ | N/A | \ No newline at end of file +| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/annotationaddedevent.mdx b/docs/components/annotationaddedevent.mdx index f21237810..d05a06237 100644 --- a/docs/components/annotationaddedevent.mdx +++ b/docs/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](../components/openairesponsesannotation.mdx) | ✅ | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | -| `annotation_index` | *int* | ✅ | N/A | | -| `content_index` | *int* | ✅ | N/A | | -| `item_id` | *str* | ✅ | N/A | | -| `output_index` | *int* | ✅ | N/A | | -| `sequence_number` | *int* | ✅ | N/A | | -| `type` | [components.AnnotationAddedEventType](../components/annotationaddedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `annotation` | [components.OpenAIResponsesAnnotation](../components/openairesponsesannotation.mdx) | :heavy_check_mark: | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | +| `annotation_index` | *int* | :heavy_check_mark: | N/A | | +| `content_index` | *int* | :heavy_check_mark: | N/A | | +| `item_id` | *str* | :heavy_check_mark: | N/A | | +| `output_index` | *int* | :heavy_check_mark: | N/A | | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.AnnotationAddedEventType](../components/annotationaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/annotationfile.mdx b/docs/components/annotationfile.mdx index f1120ec04..50ae7e895 100644 --- a/docs/components/annotationfile.mdx +++ b/docs/components/annotationfile.mdx @@ -6,5 +6,5 @@ title: "AnnotationFile" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `file` | [components.BatchObjectFile](../components/batchobjectfile.mdx) | ✅ | N/A | -| `type` | [components.AnnotationTypeFile](../components/annotationtypefile.mdx) | ✅ | N/A | \ No newline at end of file +| `file` | [components.BatchObjectFile](../components/batchobjectfile.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.AnnotationTypeFile](../components/annotationtypefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/annotationurlcitation.mdx b/docs/components/annotationurlcitation.mdx index 6eab2f076..871c61915 100644 --- a/docs/components/annotationurlcitation.mdx +++ b/docs/components/annotationurlcitation.mdx @@ -6,5 +6,5 @@ title: "AnnotationURLCitation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnnotationTypeURLCitation](../components/annotationtypeurlcitation.mdx) | ✅ | N/A | -| `url_citation` | [components.BatchObjectURLCitation](../components/batchobjecturlcitation.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.AnnotationTypeURLCitation](../components/annotationtypeurlcitation.mdx) | :heavy_check_mark: | N/A | +| `url_citation` | [components.BatchObjectURLCitation](../components/batchobjecturlcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/annotationwebsearchcitation.mdx b/docs/components/annotationwebsearchcitation.mdx index 1c94b0974..a349dfd1f 100644 --- a/docs/components/annotationwebsearchcitation.mdx +++ b/docs/components/annotationwebsearchcitation.mdx @@ -6,5 +6,5 @@ title: "AnnotationWebSearchCitation" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [components.TypeWebSearchCitation](../components/typewebsearchcitation.mdx) | ✅ | N/A | -| `web_search_citation` | [components.WebSearchCitation](../components/websearchcitation.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.TypeWebSearchCitation](../components/typewebsearchcitation.mdx) | :heavy_check_mark: | N/A | +| `web_search_citation` | [components.WebSearchCitation](../components/websearchcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicadvisormessageusageiteration.mdx b/docs/components/anthropicadvisormessageusageiteration.mdx index 85fca0d67..0d71d3657 100644 --- a/docs/components/anthropicadvisormessageusageiteration.mdx +++ b/docs/components/anthropicadvisormessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicAdvisorMessageUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cache_creation_input_tokens` | *Optional[int]* | ➖ | N/A | | -| `cache_read_input_tokens` | *Optional[int]* | ➖ | N/A | | -| `input_tokens` | *Optional[int]* | ➖ | N/A | | -| `output_tokens` | *Optional[int]* | ➖ | N/A | | -| `model` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicAdvisorMessageUsageIterationType](../components/anthropicadvisormessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicAdvisorMessageUsageIterationType](../components/anthropicadvisormessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicadvisortoolresult.mdx b/docs/components/anthropicadvisortoolresult.mdx index be52da7ba..6511ee485 100644 --- a/docs/components/anthropicadvisortoolresult.mdx +++ b/docs/components/anthropicadvisortoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicAdvisorToolResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `content` | Dict[str, *Any*] | ✅ | N/A | -| `tool_use_id` | *str* | ✅ | N/A | -| `type` | [components.AnthropicAdvisorToolResultType](../components/anthropicadvisortoolresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicAdvisorToolResultType](../components/anthropicadvisortoolresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicbase64imagesource.mdx b/docs/components/anthropicbase64imagesource.mdx index 6b399f00d..31e75cf2b 100644 --- a/docs/components/anthropicbase64imagesource.mdx +++ b/docs/components/anthropicbase64imagesource.mdx @@ -6,6 +6,6 @@ title: "AnthropicBase64ImageSource" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `data` | *str* | ✅ | N/A | | -| `media_type` | [components.AnthropicImageMimeType](../components/anthropicimagemimetype.mdx) | ✅ | N/A | image/jpeg | -| `type` | [components.AnthropicBase64ImageSourceType](../components/anthropicbase64imagesourcetype.mdx) | ✅ | N/A | | \ No newline at end of file +| `data` | *str* | :heavy_check_mark: | N/A | | +| `media_type` | [components.AnthropicImageMimeType](../components/anthropicimagemimetype.mdx) | :heavy_check_mark: | N/A | image/jpeg | +| `type` | [components.AnthropicBase64ImageSourceType](../components/anthropicbase64imagesourcetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicbase64pdfsource.mdx b/docs/components/anthropicbase64pdfsource.mdx index ab9012075..40f042630 100644 --- a/docs/components/anthropicbase64pdfsource.mdx +++ b/docs/components/anthropicbase64pdfsource.mdx @@ -6,6 +6,6 @@ title: "AnthropicBase64PdfSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | *str* | ✅ | N/A | -| `media_type` | [components.AnthropicBase64PdfSourceMediaType](../components/anthropicbase64pdfsourcemediatype.mdx) | ✅ | N/A | -| `type` | [components.AnthropicBase64PdfSourceType](../components/anthropicbase64pdfsourcetype.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | *str* | :heavy_check_mark: | N/A | +| `media_type` | [components.AnthropicBase64PdfSourceMediaType](../components/anthropicbase64pdfsourcemediatype.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicBase64PdfSourceType](../components/anthropicbase64pdfsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicbashcodeexecutionoutput.mdx b/docs/components/anthropicbashcodeexecutionoutput.mdx index 8780145b8..dc3f6e0ff 100644 --- a/docs/components/anthropicbashcodeexecutionoutput.mdx +++ b/docs/components/anthropicbashcodeexecutionoutput.mdx @@ -6,5 +6,5 @@ title: "AnthropicBashCodeExecutionOutput" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `file_id` | *str* | ✅ | N/A | -| `type` | [components.AnthropicBashCodeExecutionOutputType](../components/anthropicbashcodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicBashCodeExecutionOutputType](../components/anthropicbashcodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicbashcodeexecutionresult.mdx b/docs/components/anthropicbashcodeexecutionresult.mdx index c3678aa02..a48a5058a 100644 --- a/docs/components/anthropicbashcodeexecutionresult.mdx +++ b/docs/components/anthropicbashcodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicBashCodeExecutionResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.AnthropicBashCodeExecutionOutput](../components/anthropicbashcodeexecutionoutput.mdx)] | ✅ | N/A | -| `return_code` | *int* | ✅ | N/A | -| `stderr` | *str* | ✅ | N/A | -| `stdout` | *str* | ✅ | N/A | -| `type` | [components.AnthropicBashCodeExecutionResultType](../components/anthropicbashcodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | List[[components.AnthropicBashCodeExecutionOutput](../components/anthropicbashcodeexecutionoutput.mdx)] | :heavy_check_mark: | N/A | +| `return_code` | *int* | :heavy_check_mark: | N/A | +| `stderr` | *str* | :heavy_check_mark: | N/A | +| `stdout` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicBashCodeExecutionResultType](../components/anthropicbashcodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicbashcodeexecutiontoolresult.mdx b/docs/components/anthropicbashcodeexecutiontoolresult.mdx index 04b28ba39..339bf784d 100644 --- a/docs/components/anthropicbashcodeexecutiontoolresult.mdx +++ b/docs/components/anthropicbashcodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicBashCodeExecutionToolResult" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicBashCodeExecutionContent](../components/anthropicbashcodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | -| `tool_use_id` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicBashCodeExecutionToolResultType](../components/anthropicbashcodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `content` | [components.AnthropicBashCodeExecutionContent](../components/anthropicbashcodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicBashCodeExecutionToolResultType](../components/anthropicbashcodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicbashcodeexecutiontoolresulterror.mdx b/docs/components/anthropicbashcodeexecutiontoolresulterror.mdx index 775e485c3..ad9c88d12 100644 --- a/docs/components/anthropicbashcodeexecutiontoolresulterror.mdx +++ b/docs/components/anthropicbashcodeexecutiontoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicBashCodeExecutionToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `error_code` | [components.AnthropicBashCodeExecutionToolResultErrorErrorCode](../components/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | -| `type` | [components.AnthropicBashCodeExecutionToolResultErrorType](../components/anthropicbashcodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `error_code` | [components.AnthropicBashCodeExecutionToolResultErrorErrorCode](../components/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicBashCodeExecutionToolResultErrorType](../components/anthropicbashcodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccachecontroldirective.mdx b/docs/components/anthropiccachecontroldirective.mdx index a6c16403b..12b753fe8 100644 --- a/docs/components/anthropiccachecontroldirective.mdx +++ b/docs/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` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | -| `type` | [components.AnthropicCacheControlDirectiveType](../components/anthropiccachecontroldirectivetype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | +| `type` | [components.AnthropicCacheControlDirectiveType](../components/anthropiccachecontroldirectivetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropiccachecreation.mdx b/docs/components/anthropiccachecreation.mdx index 9f62d0c65..c9562a64e 100644 --- a/docs/components/anthropiccachecreation.mdx +++ b/docs/components/anthropiccachecreation.mdx @@ -6,5 +6,5 @@ title: "AnthropicCacheCreation" | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `ephemeral_1h_input_tokens` | *int* | ✅ | N/A | -| `ephemeral_5m_input_tokens` | *int* | ✅ | N/A | \ No newline at end of file +| `ephemeral_1h_input_tokens` | *int* | :heavy_check_mark: | N/A | +| `ephemeral_5m_input_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationcharlocation.mdx b/docs/components/anthropiccitationcharlocation.mdx index 38b939e7c..9a79e2d26 100644 --- a/docs/components/anthropiccitationcharlocation.mdx +++ b/docs/components/anthropiccitationcharlocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationCharLocation" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | ✅ | N/A | -| `document_index` | *int* | ✅ | N/A | -| `document_title` | *Nullable[str]* | ✅ | N/A | -| `end_char_index` | *int* | ✅ | N/A | -| `file_id` | *Nullable[str]* | ✅ | N/A | -| `start_char_index` | *int* | ✅ | N/A | -| `type` | [components.AnthropicCitationCharLocationType](../components/anthropiccitationcharlocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `document_index` | *int* | :heavy_check_mark: | N/A | +| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `end_char_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `start_char_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationCharLocationType](../components/anthropiccitationcharlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationcharlocationparam.mdx b/docs/components/anthropiccitationcharlocationparam.mdx index fca466aae..5a68da554 100644 --- a/docs/components/anthropiccitationcharlocationparam.mdx +++ b/docs/components/anthropiccitationcharlocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationCharLocationParam" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | ✅ | N/A | -| `document_index` | *int* | ✅ | N/A | -| `document_title` | *Nullable[str]* | ✅ | N/A | -| `end_char_index` | *int* | ✅ | N/A | -| `start_char_index` | *int* | ✅ | N/A | -| `type` | [components.AnthropicCitationCharLocationParamType](../components/anthropiccitationcharlocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `document_index` | *int* | :heavy_check_mark: | N/A | +| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `end_char_index` | *int* | :heavy_check_mark: | N/A | +| `start_char_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationCharLocationParamType](../components/anthropiccitationcharlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationcontentblocklocation.mdx b/docs/components/anthropiccitationcontentblocklocation.mdx index 03920da8a..ae50edb4e 100644 --- a/docs/components/anthropiccitationcontentblocklocation.mdx +++ b/docs/components/anthropiccitationcontentblocklocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationContentBlockLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | ✅ | N/A | -| `document_index` | *int* | ✅ | N/A | -| `document_title` | *Nullable[str]* | ✅ | N/A | -| `end_block_index` | *int* | ✅ | N/A | -| `file_id` | *Nullable[str]* | ✅ | N/A | -| `start_block_index` | *int* | ✅ | N/A | -| `type` | [components.AnthropicCitationContentBlockLocationType](../components/anthropiccitationcontentblocklocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `document_index` | *int* | :heavy_check_mark: | N/A | +| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `end_block_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `start_block_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationContentBlockLocationType](../components/anthropiccitationcontentblocklocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationcontentblocklocationparam.mdx b/docs/components/anthropiccitationcontentblocklocationparam.mdx index 6e88066df..b0353d9cc 100644 --- a/docs/components/anthropiccitationcontentblocklocationparam.mdx +++ b/docs/components/anthropiccitationcontentblocklocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationContentBlockLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | ✅ | N/A | -| `document_index` | *int* | ✅ | N/A | -| `document_title` | *Nullable[str]* | ✅ | N/A | -| `end_block_index` | *int* | ✅ | N/A | -| `start_block_index` | *int* | ✅ | N/A | -| `type` | [components.AnthropicCitationContentBlockLocationParamType](../components/anthropiccitationcontentblocklocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `document_index` | *int* | :heavy_check_mark: | N/A | +| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `end_block_index` | *int* | :heavy_check_mark: | N/A | +| `start_block_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationContentBlockLocationParamType](../components/anthropiccitationcontentblocklocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationpagelocation.mdx b/docs/components/anthropiccitationpagelocation.mdx index 922d48039..d9cb06aeb 100644 --- a/docs/components/anthropiccitationpagelocation.mdx +++ b/docs/components/anthropiccitationpagelocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationPageLocation" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | ✅ | N/A | -| `document_index` | *int* | ✅ | N/A | -| `document_title` | *Nullable[str]* | ✅ | N/A | -| `end_page_number` | *int* | ✅ | N/A | -| `file_id` | *Nullable[str]* | ✅ | N/A | -| `start_page_number` | *int* | ✅ | N/A | -| `type` | [components.AnthropicCitationPageLocationType](../components/anthropiccitationpagelocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `document_index` | *int* | :heavy_check_mark: | N/A | +| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `end_page_number` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `start_page_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationPageLocationType](../components/anthropiccitationpagelocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationpagelocationparam.mdx b/docs/components/anthropiccitationpagelocationparam.mdx index 6993270ee..137db690f 100644 --- a/docs/components/anthropiccitationpagelocationparam.mdx +++ b/docs/components/anthropiccitationpagelocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationPageLocationParam" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | ✅ | N/A | -| `document_index` | *int* | ✅ | N/A | -| `document_title` | *Nullable[str]* | ✅ | N/A | -| `end_page_number` | *int* | ✅ | N/A | -| `start_page_number` | *int* | ✅ | N/A | -| `type` | [components.AnthropicCitationPageLocationParamType](../components/anthropiccitationpagelocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `document_index` | *int* | :heavy_check_mark: | N/A | +| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `end_page_number` | *int* | :heavy_check_mark: | N/A | +| `start_page_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationPageLocationParamType](../components/anthropiccitationpagelocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationsconfig.mdx b/docs/components/anthropiccitationsconfig.mdx index 82e6fe2e4..de669423c 100644 --- a/docs/components/anthropiccitationsconfig.mdx +++ b/docs/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/components/anthropiccitationsearchresultlocation.mdx b/docs/components/anthropiccitationsearchresultlocation.mdx index e2e945d17..4766fcaad 100644 --- a/docs/components/anthropiccitationsearchresultlocation.mdx +++ b/docs/components/anthropiccitationsearchresultlocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationSearchResultLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | ✅ | N/A | -| `end_block_index` | *int* | ✅ | N/A | -| `search_result_index` | *int* | ✅ | N/A | -| `source` | *str* | ✅ | N/A | -| `start_block_index` | *int* | ✅ | N/A | -| `title` | *Nullable[str]* | ✅ | N/A | -| `type` | [components.AnthropicCitationSearchResultLocationType](../components/anthropiccitationsearchresultlocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `end_block_index` | *int* | :heavy_check_mark: | N/A | +| `search_result_index` | *int* | :heavy_check_mark: | N/A | +| `source` | *str* | :heavy_check_mark: | N/A | +| `start_block_index` | *int* | :heavy_check_mark: | N/A | +| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationSearchResultLocationType](../components/anthropiccitationsearchresultlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationsearchresultlocationparam.mdx b/docs/components/anthropiccitationsearchresultlocationparam.mdx index f3d6bdc71..8d0c9d2ac 100644 --- a/docs/components/anthropiccitationsearchresultlocationparam.mdx +++ b/docs/components/anthropiccitationsearchresultlocationparam.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationSearchResultLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | ✅ | N/A | -| `end_block_index` | *int* | ✅ | N/A | -| `search_result_index` | *int* | ✅ | N/A | -| `source` | *str* | ✅ | N/A | -| `start_block_index` | *int* | ✅ | N/A | -| `title` | *Nullable[str]* | ✅ | N/A | -| `type` | [components.AnthropicCitationSearchResultLocationParamType](../components/anthropiccitationsearchresultlocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `end_block_index` | *int* | :heavy_check_mark: | N/A | +| `search_result_index` | *int* | :heavy_check_mark: | N/A | +| `source` | *str* | :heavy_check_mark: | N/A | +| `start_block_index` | *int* | :heavy_check_mark: | N/A | +| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationSearchResultLocationParamType](../components/anthropiccitationsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationwebsearchresultlocation.mdx b/docs/components/anthropiccitationwebsearchresultlocation.mdx index 08df7f3a6..b03268fdf 100644 --- a/docs/components/anthropiccitationwebsearchresultlocation.mdx +++ b/docs/components/anthropiccitationwebsearchresultlocation.mdx @@ -6,8 +6,8 @@ title: "AnthropicCitationWebSearchResultLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | ✅ | N/A | -| `encrypted_index` | *str* | ✅ | N/A | -| `title` | *Nullable[str]* | ✅ | N/A | -| `type` | [components.AnthropicCitationWebSearchResultLocationType](../components/anthropiccitationwebsearchresultlocationtype.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `encrypted_index` | *str* | :heavy_check_mark: | N/A | +| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationWebSearchResultLocationType](../components/anthropiccitationwebsearchresultlocationtype.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationwebsearchresultlocationparam.mdx b/docs/components/anthropiccitationwebsearchresultlocationparam.mdx index e5d6bf6ab..9b59d45b7 100644 --- a/docs/components/anthropiccitationwebsearchresultlocationparam.mdx +++ b/docs/components/anthropiccitationwebsearchresultlocationparam.mdx @@ -6,8 +6,8 @@ title: "AnthropicCitationWebSearchResultLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | ✅ | N/A | -| `encrypted_index` | *str* | ✅ | N/A | -| `title` | *Nullable[str]* | ✅ | N/A | -| `type` | [components.AnthropicCitationWebSearchResultLocationParamType](../components/anthropiccitationwebsearchresultlocationparamtype.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `cited_text` | *str* | :heavy_check_mark: | N/A | +| `encrypted_index` | *str* | :heavy_check_mark: | N/A | +| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCitationWebSearchResultLocationParamType](../components/anthropiccitationwebsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecution20250825caller.mdx b/docs/components/anthropiccodeexecution20250825caller.mdx index ab9f1ca6d..78b363bf4 100644 --- a/docs/components/anthropiccodeexecution20250825caller.mdx +++ b/docs/components/anthropiccodeexecution20250825caller.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecution20250825Caller" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `tool_id` | *str* | ✅ | N/A | -| `type` | [components.AnthropicCodeExecution20250825CallerType](../components/anthropiccodeexecution20250825callertype.mdx) | ✅ | N/A | \ No newline at end of file +| `tool_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCodeExecution20250825CallerType](../components/anthropiccodeexecution20250825callertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecution20260120caller.mdx b/docs/components/anthropiccodeexecution20260120caller.mdx index 01e5b0e16..6c863ec8c 100644 --- a/docs/components/anthropiccodeexecution20260120caller.mdx +++ b/docs/components/anthropiccodeexecution20260120caller.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecution20260120Caller" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `tool_id` | *str* | ✅ | N/A | -| `type` | [components.AnthropicCodeExecution20260120CallerType](../components/anthropiccodeexecution20260120callertype.mdx) | ✅ | N/A | \ No newline at end of file +| `tool_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCodeExecution20260120CallerType](../components/anthropiccodeexecution20260120callertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecutionoutput.mdx b/docs/components/anthropiccodeexecutionoutput.mdx index 394d957ab..12529bc3c 100644 --- a/docs/components/anthropiccodeexecutionoutput.mdx +++ b/docs/components/anthropiccodeexecutionoutput.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecutionOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `file_id` | *str* | ✅ | N/A | -| `type` | [components.AnthropicCodeExecutionOutputType](../components/anthropiccodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCodeExecutionOutputType](../components/anthropiccodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecutionresult.mdx b/docs/components/anthropiccodeexecutionresult.mdx index 7b6757bd7..c1e3a98c9 100644 --- a/docs/components/anthropiccodeexecutionresult.mdx +++ b/docs/components/anthropiccodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicCodeExecutionResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `content` | List[[components.AnthropicCodeExecutionOutput](../components/anthropiccodeexecutionoutput.mdx)] | ✅ | N/A | -| `return_code` | *int* | ✅ | N/A | -| `stderr` | *str* | ✅ | N/A | -| `stdout` | *str* | ✅ | N/A | -| `type` | [components.AnthropicCodeExecutionResultType](../components/anthropiccodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | List[[components.AnthropicCodeExecutionOutput](../components/anthropiccodeexecutionoutput.mdx)] | :heavy_check_mark: | N/A | +| `return_code` | *int* | :heavy_check_mark: | N/A | +| `stderr` | *str* | :heavy_check_mark: | N/A | +| `stdout` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicCodeExecutionResultType](../components/anthropiccodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecutiontoolresult.mdx b/docs/components/anthropiccodeexecutiontoolresult.mdx index f74485d3e..fa5095cd6 100644 --- a/docs/components/anthropiccodeexecutiontoolresult.mdx +++ b/docs/components/anthropiccodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicCodeExecutionToolResult" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicCodeExecutionContent](../components/anthropiccodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | -| `tool_use_id` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicCodeExecutionToolResultType](../components/anthropiccodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `content` | [components.AnthropicCodeExecutionContent](../components/anthropiccodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicCodeExecutionToolResultType](../components/anthropiccodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecutiontoolresulterror.mdx b/docs/components/anthropiccodeexecutiontoolresulterror.mdx index 421e97cbd..200c14d0a 100644 --- a/docs/components/anthropiccodeexecutiontoolresulterror.mdx +++ b/docs/components/anthropiccodeexecutiontoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecutionToolResultError" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `error_code` | [components.AnthropicServerToolErrorCode](../components/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | -| `type` | [components.AnthropicCodeExecutionToolResultErrorType](../components/anthropiccodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | | \ No newline at end of file +| `error_code` | [components.AnthropicServerToolErrorCode](../components/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | +| `type` | [components.AnthropicCodeExecutionToolResultErrorType](../components/anthropiccodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropiccompactionblock.mdx b/docs/components/anthropiccompactionblock.mdx index 5457d7705..95ab206ec 100644 --- a/docs/components/anthropiccompactionblock.mdx +++ b/docs/components/anthropiccompactionblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicCompactionBlock" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `content` | *Nullable[str]* | ✅ | N/A | -| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.AnthropicCompactionBlockType](../components/anthropiccompactionblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.AnthropicCompactionBlockType](../components/anthropiccompactionblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccompactionusageiteration.mdx b/docs/components/anthropiccompactionusageiteration.mdx index fd869bd12..2f0a28b5a 100644 --- a/docs/components/anthropiccompactionusageiteration.mdx +++ b/docs/components/anthropiccompactionusageiteration.mdx @@ -6,9 +6,9 @@ title: "AnthropicCompactionUsageIteration" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cache_creation_input_tokens` | *Optional[int]* | ➖ | N/A | | -| `cache_read_input_tokens` | *Optional[int]* | ➖ | N/A | | -| `input_tokens` | *Optional[int]* | ➖ | N/A | | -| `output_tokens` | *Optional[int]* | ➖ | N/A | | -| `type` | [components.AnthropicCompactionUsageIterationType](../components/anthropiccompactionusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `type` | [components.AnthropicCompactionUsageIterationType](../components/anthropiccompactionusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropiccontainer.mdx b/docs/components/anthropiccontainer.mdx index cc4602aaf..620f42751 100644 --- a/docs/components/anthropiccontainer.mdx +++ b/docs/components/anthropiccontainer.mdx @@ -6,6 +6,6 @@ title: "AnthropicContainer" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `expires_at` | *str* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `skills` | List[[components.AnthropicContainerSkill](../components/anthropiccontainerskill.mdx)] | ➖ | N/A | \ No newline at end of file +| `expires_at` | *str* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `skills` | List[[components.AnthropicContainerSkill](../components/anthropiccontainerskill.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccontainerskill.mdx b/docs/components/anthropiccontainerskill.mdx index cd23ba0b6..06aea6028 100644 --- a/docs/components/anthropiccontainerskill.mdx +++ b/docs/components/anthropiccontainerskill.mdx @@ -6,6 +6,6 @@ title: "AnthropicContainerSkill" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `skill_id` | *str* | ✅ | N/A | -| `type` | [components.AnthropicContainerSkillType](../components/anthropiccontainerskilltype.mdx) | ✅ | N/A | -| `version` | *str* | ✅ | N/A | \ No newline at end of file +| `skill_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicContainerSkillType](../components/anthropiccontainerskilltype.mdx) | :heavy_check_mark: | N/A | +| `version` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccontainerupload.mdx b/docs/components/anthropiccontainerupload.mdx index 47cdd90fa..cc5c98f80 100644 --- a/docs/components/anthropiccontainerupload.mdx +++ b/docs/components/anthropiccontainerupload.mdx @@ -6,5 +6,5 @@ title: "AnthropicContainerUpload" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `file_id` | *str* | ✅ | N/A | -| `type` | [components.AnthropicContainerUploadType](../components/anthropiccontaineruploadtype.mdx) | ✅ | N/A | \ No newline at end of file +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicContainerUploadType](../components/anthropiccontaineruploadtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicdirectcaller.mdx b/docs/components/anthropicdirectcaller.mdx index a685353e2..970780a2c 100644 --- a/docs/components/anthropicdirectcaller.mdx +++ b/docs/components/anthropicdirectcaller.mdx @@ -6,4 +6,4 @@ title: "AnthropicDirectCaller" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnthropicDirectCallerType](../components/anthropicdirectcallertype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.AnthropicDirectCallerType](../components/anthropicdirectcallertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicdocumentblock.mdx b/docs/components/anthropicdocumentblock.mdx index 8b33d1a19..6d9011ff6 100644 --- a/docs/components/anthropicdocumentblock.mdx +++ b/docs/components/anthropicdocumentblock.mdx @@ -6,7 +6,7 @@ title: "AnthropicDocumentBlock" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `citations` | [OptionalNullable[components.AnthropicCitationsConfig]](../components/anthropiccitationsconfig.mdx) | ➖ | N/A | \{
"enabled": true
} | -| `source` | [components.AnthropicDocumentBlockSource](../components/anthropicdocumentblocksource.mdx) | ✅ | N/A | | -| `title` | *Nullable[str]* | ✅ | N/A | | -| `type` | [components.AnthropicDocumentBlockType](../components/anthropicdocumentblocktype.mdx) | ✅ | N/A | | \ No newline at end of file +| `citations` | [OptionalNullable[components.AnthropicCitationsConfig]](../components/anthropiccitationsconfig.mdx) | :heavy_minus_sign: | N/A | \{
"enabled": true
} | +| `source` | [components.AnthropicDocumentBlockSource](../components/anthropicdocumentblocksource.mdx) | :heavy_check_mark: | N/A | | +| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicDocumentBlockType](../components/anthropicdocumentblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicdocumentblockparam.mdx b/docs/components/anthropicdocumentblockparam.mdx index 52f444d80..f49b66264 100644 --- a/docs/components/anthropicdocumentblockparam.mdx +++ b/docs/components/anthropicdocumentblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicDocumentBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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[components.AnthropicDocumentBlockParamCitations]](../components/anthropicdocumentblockparamcitations.mdx) | ➖ | N/A | | -| `context` | *OptionalNullable[str]* | ➖ | N/A | | -| `source` | [components.AnthropicDocumentBlockParamSourceUnion](../components/anthropicdocumentblockparamsourceunion.mdx) | ✅ | N/A | | -| `title` | *OptionalNullable[str]* | ➖ | N/A | | -| `type` | [components.AnthropicDocumentBlockParamTypeDocument](../components/anthropicdocumentblockparamtypedocument.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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[components.AnthropicDocumentBlockParamCitations]](../components/anthropicdocumentblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | +| `context` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `source` | [components.AnthropicDocumentBlockParamSourceUnion](../components/anthropicdocumentblockparamsourceunion.mdx) | :heavy_check_mark: | N/A | | +| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.AnthropicDocumentBlockParamTypeDocument](../components/anthropicdocumentblockparamtypedocument.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicdocumentblockparamcitations.mdx b/docs/components/anthropicdocumentblockparamcitations.mdx index e86294f85..c8b4d39a9 100644 --- a/docs/components/anthropicdocumentblockparamcitations.mdx +++ b/docs/components/anthropicdocumentblockparamcitations.mdx @@ -6,4 +6,4 @@ title: "AnthropicDocumentBlockParamCitations" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *Optional[bool]* | ➖ | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicencryptedcodeexecutionresult.mdx b/docs/components/anthropicencryptedcodeexecutionresult.mdx index 5828d7272..2f992ca40 100644 --- a/docs/components/anthropicencryptedcodeexecutionresult.mdx +++ b/docs/components/anthropicencryptedcodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicEncryptedCodeExecutionResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `content` | List[[components.AnthropicCodeExecutionOutput](../components/anthropiccodeexecutionoutput.mdx)] | ✅ | N/A | -| `encrypted_stdout` | *str* | ✅ | N/A | -| `return_code` | *int* | ✅ | N/A | -| `stderr` | *str* | ✅ | N/A | -| `type` | [components.AnthropicEncryptedCodeExecutionResultType](../components/anthropicencryptedcodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | List[[components.AnthropicCodeExecutionOutput](../components/anthropiccodeexecutionoutput.mdx)] | :heavy_check_mark: | N/A | +| `encrypted_stdout` | *str* | :heavy_check_mark: | N/A | +| `return_code` | *int* | :heavy_check_mark: | N/A | +| `stderr` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicEncryptedCodeExecutionResultType](../components/anthropicencryptedcodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicfile.mdx b/docs/components/anthropicfile.mdx index ada2b77a9..7e1012dc7 100644 --- a/docs/components/anthropicfile.mdx +++ b/docs/components/anthropicfile.mdx @@ -9,11 +9,11 @@ A stored file in Anthropic's Files API shape. | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `shape` | [components.AnthropicFileShape](../components/anthropicfileshape.mdx) | ✅ | N/A | -| `created_at` | *str* | ✅ | N/A | -| `downloadable` | *bool* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `mime_type` | *str* | ✅ | N/A | -| `size_bytes` | *int* | ✅ | N/A | -| `type` | [components.AnthropicFileType](../components/anthropicfiletype.mdx) | ✅ | N/A | \ No newline at end of file +| `shape` | [components.AnthropicFileShape](../components/anthropicfileshape.mdx) | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `downloadable` | *bool* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `mime_type` | *str* | :heavy_check_mark: | N/A | +| `size_bytes` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicFileType](../components/anthropicfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicfiledeleted.mdx b/docs/components/anthropicfiledeleted.mdx index bd28047a1..2e4f78952 100644 --- a/docs/components/anthropicfiledeleted.mdx +++ b/docs/components/anthropicfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in Anthropic's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `shape` | [components.AnthropicFileDeletedShape](../components/anthropicfiledeletedshape.mdx) | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `type` | [components.AnthropicFileDeletedType](../components/anthropicfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file +| `shape` | [components.AnthropicFileDeletedShape](../components/anthropicfiledeletedshape.mdx) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicFileDeletedType](../components/anthropicfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicfiledocumentsource.mdx b/docs/components/anthropicfiledocumentsource.mdx index 395524095..9b1f7560f 100644 --- a/docs/components/anthropicfiledocumentsource.mdx +++ b/docs/components/anthropicfiledocumentsource.mdx @@ -6,5 +6,5 @@ title: "AnthropicFileDocumentSource" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `file_id` | *str* | ✅ | N/A | -| `type` | [components.AnthropicFileDocumentSourceType](../components/anthropicfiledocumentsourcetype.mdx) | ✅ | N/A | \ No newline at end of file +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicFileDocumentSourceType](../components/anthropicfiledocumentsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicfilelist.mdx b/docs/components/anthropicfilelist.mdx index f0cbb8b7c..59fc87350 100644 --- a/docs/components/anthropicfilelist.mdx +++ b/docs/components/anthropicfilelist.mdx @@ -9,8 +9,8 @@ A page of files in Anthropic's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `shape` | [components.AnthropicFileListShape](../components/anthropicfilelistshape.mdx) | ✅ | N/A | -| `data` | List[[components.AnthropicFile](../components/anthropicfile.mdx)] | ✅ | N/A | -| `first_id` | *Nullable[str]* | ✅ | N/A | -| `has_more` | *bool* | ✅ | N/A | -| `last_id` | *Nullable[str]* | ✅ | N/A | \ No newline at end of file +| `shape` | [components.AnthropicFileListShape](../components/anthropicfilelistshape.mdx) | :heavy_check_mark: | N/A | +| `data` | List[[components.AnthropicFile](../components/anthropicfile.mdx)] | :heavy_check_mark: | N/A | +| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `has_more` | *bool* | :heavy_check_mark: | N/A | +| `last_id` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicimageblockparam.mdx b/docs/components/anthropicimageblockparam.mdx index 1cb784d5d..9be25eff1 100644 --- a/docs/components/anthropicimageblockparam.mdx +++ b/docs/components/anthropicimageblockparam.mdx @@ -6,6 +6,6 @@ title: "AnthropicImageBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/anthropicimageblockparamsource.mdx) | ✅ | N/A | | -| `type` | [components.AnthropicImageBlockParamType](../components/anthropicimageblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/anthropicimageblockparamsource.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicImageBlockParamType](../components/anthropicimageblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicinputtokensclearatleast.mdx b/docs/components/anthropicinputtokensclearatleast.mdx index 74ad3d2fa..0c85fad24 100644 --- a/docs/components/anthropicinputtokensclearatleast.mdx +++ b/docs/components/anthropicinputtokensclearatleast.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensClearAtLeast" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicInputTokensClearAtLeastType](../components/anthropicinputtokensclearatleasttype.mdx) | ✅ | N/A | -| `value` | *int* | ✅ | N/A | \ No newline at end of file +| `type` | [components.AnthropicInputTokensClearAtLeastType](../components/anthropicinputtokensclearatleasttype.mdx) | :heavy_check_mark: | N/A | +| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicinputtokenstrigger.mdx b/docs/components/anthropicinputtokenstrigger.mdx index 4662c08a6..72fe90a57 100644 --- a/docs/components/anthropicinputtokenstrigger.mdx +++ b/docs/components/anthropicinputtokenstrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensTrigger" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicInputTokensTriggerType](../components/anthropicinputtokenstriggertype.mdx) | ✅ | N/A | -| `value` | *int* | ✅ | N/A | \ No newline at end of file +| `type` | [components.AnthropicInputTokensTriggerType](../components/anthropicinputtokenstriggertype.mdx) | :heavy_check_mark: | N/A | +| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicinputtransformation.mdx b/docs/components/anthropicinputtransformation.mdx index ec4d4d8ed..5eadea136 100644 --- a/docs/components/anthropicinputtransformation.mdx +++ b/docs/components/anthropicinputtransformation.mdx @@ -9,7 +9,7 @@ A server-side transformation Anthropic applied to the request input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `path` | *OptionalNullable[str]* | ➖ | N/A | | -| `reason` | *OptionalNullable[str]* | ➖ | N/A | | -| `type` | *str* | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"path": "messages.1.content.0",
"reason": "prefix_binding_mismatch",
"type": "thinking_dropped"
} | \ No newline at end of file +| `path` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `reason` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `type` | *str* | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/anthropiciterationcachecreation.mdx b/docs/components/anthropiciterationcachecreation.mdx index 0646c4a73..29b33e64a 100644 --- a/docs/components/anthropiciterationcachecreation.mdx +++ b/docs/components/anthropiciterationcachecreation.mdx @@ -6,5 +6,5 @@ title: "AnthropicIterationCacheCreation" | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `ephemeral_1h_input_tokens` | *Optional[int]* | ➖ | N/A | -| `ephemeral_5m_input_tokens` | *Optional[int]* | ➖ | N/A | \ No newline at end of file +| `ephemeral_1h_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `ephemeral_5m_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicmessageoutputconfig.mdx b/docs/components/anthropicmessageoutputconfig.mdx index 0e323aae4..c96c40a53 100644 --- a/docs/components/anthropicmessageoutputconfig.mdx +++ b/docs/components/anthropicmessageoutputconfig.mdx @@ -6,4 +6,4 @@ title: "AnthropicMessageOutputConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.AnthropicOutputEffort]](../components/anthropicoutputeffort.mdx) | ➖ | N/A | high | \ No newline at end of file +| `effort` | [OptionalNullable[components.AnthropicOutputEffort]](../components/anthropicoutputeffort.mdx) | :heavy_minus_sign: | N/A | high | \ No newline at end of file diff --git a/docs/components/anthropicmessageusageiteration.mdx b/docs/components/anthropicmessageusageiteration.mdx index bc0302220..01ec99b0e 100644 --- a/docs/components/anthropicmessageusageiteration.mdx +++ b/docs/components/anthropicmessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicMessageUsageIteration" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cache_creation_input_tokens` | *Optional[int]* | ➖ | N/A | | -| `cache_read_input_tokens` | *Optional[int]* | ➖ | N/A | | -| `input_tokens` | *Optional[int]* | ➖ | N/A | | -| `output_tokens` | *Optional[int]* | ➖ | N/A | | -| `model` | *Optional[str]* | ➖ | N/A | | -| `type` | [components.AnthropicMessageUsageIterationType](../components/anthropicmessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.AnthropicMessageUsageIterationType](../components/anthropicmessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicoutputtokensdetails.mdx b/docs/components/anthropicoutputtokensdetails.mdx index cacf5afa8..5e5317081 100644 --- a/docs/components/anthropicoutputtokensdetails.mdx +++ b/docs/components/anthropicoutputtokensdetails.mdx @@ -6,4 +6,4 @@ title: "AnthropicOutputTokensDetails" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `thinking_tokens` | *int* | ✅ | N/A | \ No newline at end of file +| `thinking_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicplaintextsource.mdx b/docs/components/anthropicplaintextsource.mdx index 3dd144945..3a07d04fc 100644 --- a/docs/components/anthropicplaintextsource.mdx +++ b/docs/components/anthropicplaintextsource.mdx @@ -6,6 +6,6 @@ title: "AnthropicPlainTextSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | *str* | ✅ | N/A | -| `media_type` | [components.AnthropicPlainTextSourceMediaType](../components/anthropicplaintextsourcemediatype.mdx) | ✅ | N/A | -| `type` | [components.AnthropicPlainTextSourceType](../components/anthropicplaintextsourcetype.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | *str* | :heavy_check_mark: | N/A | +| `media_type` | [components.AnthropicPlainTextSourceMediaType](../components/anthropicplaintextsourcemediatype.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicPlainTextSourceType](../components/anthropicplaintextsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicredactedthinkingblock.mdx b/docs/components/anthropicredactedthinkingblock.mdx index 502fdbc55..df0aaeaae 100644 --- a/docs/components/anthropicredactedthinkingblock.mdx +++ b/docs/components/anthropicredactedthinkingblock.mdx @@ -6,5 +6,5 @@ title: "AnthropicRedactedThinkingBlock" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `data` | *str* | ✅ | N/A | -| `type` | [components.AnthropicRedactedThinkingBlockType](../components/anthropicredactedthinkingblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicRedactedThinkingBlockType](../components/anthropicredactedthinkingblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicrefusalstopdetails.mdx b/docs/components/anthropicrefusalstopdetails.mdx index 38846ce56..0b310ef75 100644 --- a/docs/components/anthropicrefusalstopdetails.mdx +++ b/docs/components/anthropicrefusalstopdetails.mdx @@ -9,6 +9,6 @@ Structured information about a refusal | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `category` | [Nullable[components.AnthropicRefusalStopDetailsCategory]](../components/anthropicrefusalstopdetailscategory.mdx) | ✅ | N/A | -| `explanation` | *Nullable[str]* | ✅ | N/A | -| `type` | [components.AnthropicRefusalStopDetailsType](../components/anthropicrefusalstopdetailstype.mdx) | ✅ | N/A | \ No newline at end of file +| `category` | [Nullable[components.AnthropicRefusalStopDetailsCategory]](../components/anthropicrefusalstopdetailscategory.mdx) | :heavy_check_mark: | N/A | +| `explanation` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicRefusalStopDetailsType](../components/anthropicrefusalstopdetailstype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicsafeguard.mdx b/docs/components/anthropicsafeguard.mdx index 111457158..91de925eb 100644 --- a/docs/components/anthropicsafeguard.mdx +++ b/docs/components/anthropicsafeguard.mdx @@ -9,6 +9,6 @@ A server-side safeguard Anthropic evaluates alongside the completion | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `classifier_context` | Dict[str, *Any*] | ➖ | N/A | | -| `type` | *str* | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"classifier_context": \{
"permission_mode": "auto",
"v": 1
},
"type": "dangerous_tool_use"
} | \ No newline at end of file +| `classifier_context` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `type` | *str* | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/anthropicsearchresultblockparam.mdx b/docs/components/anthropicsearchresultblockparam.mdx index 85ff6950a..89ae1afd5 100644 --- a/docs/components/anthropicsearchresultblockparam.mdx +++ b/docs/components/anthropicsearchresultblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicSearchResultBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.AnthropicSearchResultBlockParamCitations]](../components/anthropicsearchresultblockparamcitations.mdx) | ➖ | N/A | | -| `content` | List[[components.AnthropicTextBlockParam](../components/anthropictextblockparam.mdx)] | ✅ | N/A | | -| `source` | *str* | ✅ | N/A | | -| `title` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicSearchResultBlockParamType](../components/anthropicsearchresultblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.AnthropicSearchResultBlockParamCitations]](../components/anthropicsearchresultblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | +| `content` | List[[components.AnthropicTextBlockParam](../components/anthropictextblockparam.mdx)] | :heavy_check_mark: | N/A | | +| `source` | *str* | :heavy_check_mark: | N/A | | +| `title` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicSearchResultBlockParamType](../components/anthropicsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicsearchresultblockparamcitations.mdx b/docs/components/anthropicsearchresultblockparamcitations.mdx index 9b1c23b03..107bda327 100644 --- a/docs/components/anthropicsearchresultblockparamcitations.mdx +++ b/docs/components/anthropicsearchresultblockparamcitations.mdx @@ -6,4 +6,4 @@ title: "AnthropicSearchResultBlockParamCitations" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *Optional[bool]* | ➖ | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicservertoolusage.mdx b/docs/components/anthropicservertoolusage.mdx index bad3454c4..c3f95be74 100644 --- a/docs/components/anthropicservertoolusage.mdx +++ b/docs/components/anthropicservertoolusage.mdx @@ -6,5 +6,5 @@ title: "AnthropicServerToolUsage" | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `web_fetch_requests` | *int* | ✅ | N/A | -| `web_search_requests` | *int* | ✅ | N/A | \ No newline at end of file +| `web_fetch_requests` | *int* | :heavy_check_mark: | N/A | +| `web_search_requests` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropictextblock.mdx b/docs/components/anthropictextblock.mdx index 7c6f62713..ac26f79de 100644 --- a/docs/components/anthropictextblock.mdx +++ b/docs/components/anthropictextblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextBlock" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `citations` | List[[components.AnthropicTextCitation](../components/anthropictextcitation.mdx)] | ✅ | N/A | -| `text` | *str* | ✅ | N/A | -| `type` | [components.AnthropicTextBlockType](../components/anthropictextblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `citations` | List[[components.AnthropicTextCitation](../components/anthropictextcitation.mdx)] | :heavy_check_mark: | N/A | +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicTextBlockType](../components/anthropictextblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropictextblockparam.mdx b/docs/components/anthropictextblockparam.mdx index 5bc1a621d..502d15e61 100644 --- a/docs/components/anthropictextblockparam.mdx +++ b/docs/components/anthropictextblockparam.mdx @@ -6,7 +6,7 @@ title: "AnthropicTextBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | List[[components.Citation](../components/citation.mdx)] | ➖ | N/A | | -| `text` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicTextBlockParamType](../components/anthropictextblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | List[[components.Citation](../components/citation.mdx)] | :heavy_minus_sign: | N/A | | +| `text` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicTextBlockParamType](../components/anthropictextblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutioncreateresult.mdx b/docs/components/anthropictexteditorcodeexecutioncreateresult.mdx index f1228b91c..7e94b8f76 100644 --- a/docs/components/anthropictexteditorcodeexecutioncreateresult.mdx +++ b/docs/components/anthropictexteditorcodeexecutioncreateresult.mdx @@ -6,5 +6,5 @@ title: "AnthropicTextEditorCodeExecutionCreateResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `is_file_update` | *bool* | ✅ | N/A | -| `type` | [components.AnthropicTextEditorCodeExecutionCreateResultType](../components/anthropictexteditorcodeexecutioncreateresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `is_file_update` | *bool* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicTextEditorCodeExecutionCreateResultType](../components/anthropictexteditorcodeexecutioncreateresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx b/docs/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx index f989850cc..cd8b9eeff 100644 --- a/docs/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx +++ b/docs/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx @@ -6,9 +6,9 @@ title: "AnthropicTextEditorCodeExecutionStrReplaceResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `lines` | List[*str*] | ✅ | N/A | -| `new_lines` | *Nullable[int]* | ✅ | N/A | -| `new_start` | *Nullable[int]* | ✅ | N/A | -| `old_lines` | *Nullable[int]* | ✅ | N/A | -| `old_start` | *Nullable[int]* | ✅ | N/A | -| `type` | [components.AnthropicTextEditorCodeExecutionStrReplaceResultType](../components/anthropictexteditorcodeexecutionstrreplaceresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `lines` | List[*str*] | :heavy_check_mark: | N/A | +| `new_lines` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `new_start` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `old_lines` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `old_start` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicTextEditorCodeExecutionStrReplaceResultType](../components/anthropictexteditorcodeexecutionstrreplaceresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutiontoolresult.mdx b/docs/components/anthropictexteditorcodeexecutiontoolresult.mdx index da4817358..9c05b4427 100644 --- a/docs/components/anthropictexteditorcodeexecutiontoolresult.mdx +++ b/docs/components/anthropictexteditorcodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextEditorCodeExecutionToolResult" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicTextEditorCodeExecutionContent](../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"
} | -| `tool_use_id` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicTextEditorCodeExecutionToolResultType](../components/anthropictexteditorcodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `content` | [components.AnthropicTextEditorCodeExecutionContent](../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"
} | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicTextEditorCodeExecutionToolResultType](../components/anthropictexteditorcodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutiontoolresulterror.mdx b/docs/components/anthropictexteditorcodeexecutiontoolresulterror.mdx index f79c9d595..c818a4b4c 100644 --- a/docs/components/anthropictexteditorcodeexecutiontoolresulterror.mdx +++ b/docs/components/anthropictexteditorcodeexecutiontoolresulterror.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextEditorCodeExecutionToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `error_code` | [components.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../components/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | -| `error_message` | *Nullable[str]* | ✅ | N/A | -| `type` | [components.AnthropicTextEditorCodeExecutionToolResultErrorType](../components/anthropictexteditorcodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `error_code` | [components.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../components/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | +| `error_message` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicTextEditorCodeExecutionToolResultErrorType](../components/anthropictexteditorcodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutionviewresult.mdx b/docs/components/anthropictexteditorcodeexecutionviewresult.mdx index cba28c9df..f1fe04cac 100644 --- a/docs/components/anthropictexteditorcodeexecutionviewresult.mdx +++ b/docs/components/anthropictexteditorcodeexecutionviewresult.mdx @@ -6,9 +6,9 @@ title: "AnthropicTextEditorCodeExecutionViewResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `content` | *str* | ✅ | N/A | -| `file_type` | [components.FileType](../components/filetype.mdx) | ✅ | N/A | -| `num_lines` | *Nullable[int]* | ✅ | N/A | -| `start_line` | *Nullable[int]* | ✅ | N/A | -| `total_lines` | *Nullable[int]* | ✅ | N/A | -| `type` | [components.AnthropicTextEditorCodeExecutionViewResultType](../components/anthropictexteditorcodeexecutionviewresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | *str* | :heavy_check_mark: | N/A | +| `file_type` | [components.FileType](../components/filetype.mdx) | :heavy_check_mark: | N/A | +| `num_lines` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `start_line` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `total_lines` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicTextEditorCodeExecutionViewResultType](../components/anthropictexteditorcodeexecutionviewresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicthinkingblock.mdx b/docs/components/anthropicthinkingblock.mdx index 2f9d95c4e..7ca58e1c0 100644 --- a/docs/components/anthropicthinkingblock.mdx +++ b/docs/components/anthropicthinkingblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicThinkingBlock" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `signature` | *str* | ✅ | N/A | -| `thinking` | *str* | ✅ | N/A | -| `type` | [components.AnthropicThinkingBlockType](../components/anthropicthinkingblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `signature` | *str* | :heavy_check_mark: | N/A | +| `thinking` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicThinkingBlockType](../components/anthropicthinkingblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicthinkingblockbinding.mdx b/docs/components/anthropicthinkingblockbinding.mdx index 8f259847b..cc9f8e6a2 100644 --- a/docs/components/anthropicthinkingblockbinding.mdx +++ b/docs/components/anthropicthinkingblockbinding.mdx @@ -6,5 +6,5 @@ title: "AnthropicThinkingBlockBinding" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ~~`mismatch_behavior`~~ | [OptionalNullable[components.MismatchBehavior]](../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. | -| `prefix_mismatch_behavior` | [OptionalNullable[components.PrefixMismatchBehavior]](../components/prefixmismatchbehavior.mdx) | ➖ | N/A | \ No newline at end of file +| ~~`mismatch_behavior`~~ | [OptionalNullable[components.MismatchBehavior]](../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. | +| `prefix_mismatch_behavior` | [OptionalNullable[components.PrefixMismatchBehavior]](../components/prefixmismatchbehavior.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicthinkingturns.mdx b/docs/components/anthropicthinkingturns.mdx index d4c53fd01..9c9202152 100644 --- a/docs/components/anthropicthinkingturns.mdx +++ b/docs/components/anthropicthinkingturns.mdx @@ -6,5 +6,5 @@ title: "AnthropicThinkingTurns" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.AnthropicThinkingTurnsType](../components/anthropicthinkingturnstype.mdx) | ✅ | N/A | -| `value` | *int* | ✅ | N/A | \ No newline at end of file +| `type` | [components.AnthropicThinkingTurnsType](../components/anthropicthinkingturnstype.mdx) | :heavy_check_mark: | N/A | +| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropictoolreference.mdx b/docs/components/anthropictoolreference.mdx index cece19a06..ee8d6b278 100644 --- a/docs/components/anthropictoolreference.mdx +++ b/docs/components/anthropictoolreference.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `tool_name` | *str* | ✅ | N/A | -| `type` | [components.AnthropicToolReferenceType](../components/anthropictoolreferencetype.mdx) | ✅ | N/A | \ No newline at end of file +| `tool_name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicToolReferenceType](../components/anthropictoolreferencetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchresult.mdx b/docs/components/anthropictoolsearchresult.mdx index 22a5297af..69a738d24 100644 --- a/docs/components/anthropictoolsearchresult.mdx +++ b/docs/components/anthropictoolsearchresult.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolSearchResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `tool_references` | List[[components.AnthropicToolReference](../components/anthropictoolreference.mdx)] | ✅ | N/A | -| `type` | [components.AnthropicToolSearchResultType](../components/anthropictoolsearchresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `tool_references` | List[[components.AnthropicToolReference](../components/anthropictoolreference.mdx)] | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicToolSearchResultType](../components/anthropictoolsearchresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchresulterror.mdx b/docs/components/anthropictoolsearchresulterror.mdx index 702eaaa28..1e624f118 100644 --- a/docs/components/anthropictoolsearchresulterror.mdx +++ b/docs/components/anthropictoolsearchresulterror.mdx @@ -6,6 +6,6 @@ title: "AnthropicToolSearchResultError" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `error_code` | [components.AnthropicServerToolErrorCode](../components/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | -| `error_message` | *Nullable[str]* | ✅ | N/A | | -| `type` | [components.AnthropicToolSearchResultErrorType](../components/anthropictoolsearchresulterrortype.mdx) | ✅ | N/A | | \ No newline at end of file +| `error_code` | [components.AnthropicServerToolErrorCode](../components/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | +| `error_message` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicToolSearchResultErrorType](../components/anthropictoolsearchresulterrortype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchtoolbm25.mdx b/docs/components/anthropictoolsearchtoolbm25.mdx index 3b2423fb2..0481dd033 100644 --- a/docs/components/anthropictoolsearchtoolbm25.mdx +++ b/docs/components/anthropictoolsearchtoolbm25.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolBm25" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | ➖ | N/A | [
"direct"
] | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `defer_loading` | *Optional[bool]* | ➖ | N/A | | -| `name` | [components.AnthropicToolSearchToolBm25Name](../components/anthropictoolsearchtoolbm25name.mdx) | ✅ | N/A | | -| `strict` | *Optional[bool]* | ➖ | N/A | | -| `type` | [components.AnthropicToolSearchToolBm25Type](../components/anthropictoolsearchtoolbm25type.mdx) | ✅ | N/A | | \ No newline at end of file +| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | :heavy_minus_sign: | N/A | [
"direct"
] | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `name` | [components.AnthropicToolSearchToolBm25Name](../components/anthropictoolsearchtoolbm25name.mdx) | :heavy_check_mark: | N/A | | +| `strict` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `type` | [components.AnthropicToolSearchToolBm25Type](../components/anthropictoolsearchtoolbm25type.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchtoolregex.mdx b/docs/components/anthropictoolsearchtoolregex.mdx index dd71f6ade..9eaa23460 100644 --- a/docs/components/anthropictoolsearchtoolregex.mdx +++ b/docs/components/anthropictoolsearchtoolregex.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolRegex" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | ➖ | N/A | [
"direct"
] | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `defer_loading` | *Optional[bool]* | ➖ | N/A | | -| `name` | [components.AnthropicToolSearchToolRegexName](../components/anthropictoolsearchtoolregexname.mdx) | ✅ | N/A | | -| `strict` | *Optional[bool]* | ➖ | N/A | | -| `type` | [components.AnthropicToolSearchToolRegexType](../components/anthropictoolsearchtoolregextype.mdx) | ✅ | N/A | | \ No newline at end of file +| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | :heavy_minus_sign: | N/A | [
"direct"
] | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `name` | [components.AnthropicToolSearchToolRegexName](../components/anthropictoolsearchtoolregexname.mdx) | :heavy_check_mark: | N/A | | +| `strict` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `type` | [components.AnthropicToolSearchToolRegexType](../components/anthropictoolsearchtoolregextype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchtoolresult.mdx b/docs/components/anthropictoolsearchtoolresult.mdx index 6efe83646..191c13c22 100644 --- a/docs/components/anthropictoolsearchtoolresult.mdx +++ b/docs/components/anthropictoolsearchtoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicToolSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicToolSearchContent](../components/anthropictoolsearchcontent.mdx) | ✅ | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | -| `tool_use_id` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicToolSearchToolResultType](../components/anthropictoolsearchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `content` | [components.AnthropicToolSearchContent](../components/anthropictoolsearchcontent.mdx) | :heavy_check_mark: | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicToolSearchToolResultType](../components/anthropictoolsearchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictooluseblock.mdx b/docs/components/anthropictooluseblock.mdx index 8f4e92fa8..51bc60d20 100644 --- a/docs/components/anthropictooluseblock.mdx +++ b/docs/components/anthropictooluseblock.mdx @@ -6,8 +6,8 @@ title: "AnthropicToolUseBlock" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | -| `id` | *str* | ✅ | N/A | | -| `input` | *Optional[Any]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicToolUseBlockType](../components/anthropictooluseblocktype.mdx) | ✅ | N/A | | \ No newline at end of file +| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `input` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicToolUseBlockType](../components/anthropictooluseblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictooluseskeep.mdx b/docs/components/anthropictooluseskeep.mdx index a552a6104..56a3b082a 100644 --- a/docs/components/anthropictooluseskeep.mdx +++ b/docs/components/anthropictooluseskeep.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesKeep" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnthropicToolUsesKeepType](../components/anthropictooluseskeeptype.mdx) | ✅ | N/A | -| `value` | *int* | ✅ | N/A | \ No newline at end of file +| `type` | [components.AnthropicToolUsesKeepType](../components/anthropictooluseskeeptype.mdx) | :heavy_check_mark: | N/A | +| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropictoolusestrigger.mdx b/docs/components/anthropictoolusestrigger.mdx index 7a62403e9..ddf146336 100644 --- a/docs/components/anthropictoolusestrigger.mdx +++ b/docs/components/anthropictoolusestrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesTrigger" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicToolUsesTriggerType](../components/anthropictoolusestriggertype.mdx) | ✅ | N/A | -| `value` | *int* | ✅ | N/A | \ No newline at end of file +| `type` | [components.AnthropicToolUsesTriggerType](../components/anthropictoolusestriggertype.mdx) | :heavy_check_mark: | N/A | +| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicunknownusageiteration.mdx b/docs/components/anthropicunknownusageiteration.mdx index 9571ae700..9a298f507 100644 --- a/docs/components/anthropicunknownusageiteration.mdx +++ b/docs/components/anthropicunknownusageiteration.mdx @@ -6,9 +6,9 @@ title: "AnthropicUnknownUsageIteration" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cache_creation_input_tokens` | *Optional[int]* | ➖ | N/A | | -| `cache_read_input_tokens` | *Optional[int]* | ➖ | N/A | | -| `input_tokens` | *Optional[int]* | ➖ | N/A | | -| `output_tokens` | *Optional[int]* | ➖ | N/A | | -| `type` | *str* | ✅ | N/A | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `type` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicurlimagesource.mdx b/docs/components/anthropicurlimagesource.mdx index da55e53d6..ac9136051 100644 --- a/docs/components/anthropicurlimagesource.mdx +++ b/docs/components/anthropicurlimagesource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLImageSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicURLImageSourceType](../components/anthropicurlimagesourcetype.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `type` | [components.AnthropicURLImageSourceType](../components/anthropicurlimagesourcetype.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicurlpdfsource.mdx b/docs/components/anthropicurlpdfsource.mdx index 21d429202..50d60b95a 100644 --- a/docs/components/anthropicurlpdfsource.mdx +++ b/docs/components/anthropicurlpdfsource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLPdfSource" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnthropicURLPdfSourceType](../components/anthropicurlpdfsourcetype.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `type` | [components.AnthropicURLPdfSourceType](../components/anthropicurlpdfsourcetype.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebfetchblock.mdx b/docs/components/anthropicwebfetchblock.mdx index d0f33b835..e130a5784 100644 --- a/docs/components/anthropicwebfetchblock.mdx +++ b/docs/components/anthropicwebfetchblock.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebFetchBlock" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicDocumentBlock](../components/anthropicdocumentblock.mdx) | ✅ | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | -| `retrieved_at` | *Nullable[str]* | ✅ | N/A | | -| `type` | [components.AnthropicWebFetchBlockType](../components/anthropicwebfetchblocktype.mdx) | ✅ | N/A | | -| `url` | *str* | ✅ | N/A | | \ No newline at end of file +| `content` | [components.AnthropicDocumentBlock](../components/anthropicdocumentblock.mdx) | :heavy_check_mark: | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | +| `retrieved_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicWebFetchBlockType](../components/anthropicwebfetchblocktype.mdx) | :heavy_check_mark: | N/A | | +| `url` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicwebfetchtoolresult.mdx b/docs/components/anthropicwebfetchtoolresult.mdx index db198b593..d33f72fbf 100644 --- a/docs/components/anthropicwebfetchtoolresult.mdx +++ b/docs/components/anthropicwebfetchtoolresult.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebFetchToolResult" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | -| `content` | [components.AnthropicWebFetchContent](../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"
} | -| `tool_use_id` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicWebFetchToolResultType](../components/anthropicwebfetchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | +| `content` | [components.AnthropicWebFetchContent](../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"
} | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicWebFetchToolResultType](../components/anthropicwebfetchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicwebfetchtoolresulterror.mdx b/docs/components/anthropicwebfetchtoolresulterror.mdx index 1b9ea9f31..3b9150ee7 100644 --- a/docs/components/anthropicwebfetchtoolresulterror.mdx +++ b/docs/components/anthropicwebfetchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicWebFetchToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `error_code` | [components.AnthropicWebFetchToolResultErrorErrorCode](../components/anthropicwebfetchtoolresulterrorerrorcode.mdx) | ✅ | N/A | -| `type` | [components.AnthropicWebFetchToolResultErrorType](../components/anthropicwebfetchtoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `error_code` | [components.AnthropicWebFetchToolResultErrorErrorCode](../components/anthropicwebfetchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicWebFetchToolResultErrorType](../components/anthropicwebfetchtoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchresult.mdx b/docs/components/anthropicwebsearchresult.mdx index 510a38e9b..9f44a3136 100644 --- a/docs/components/anthropicwebsearchresult.mdx +++ b/docs/components/anthropicwebsearchresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `encrypted_content` | *str* | ✅ | N/A | -| `page_age` | *Nullable[str]* | ✅ | N/A | -| `title` | *str* | ✅ | N/A | -| `type` | [components.AnthropicWebSearchResultType](../components/anthropicwebsearchresulttype.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `encrypted_content` | *str* | :heavy_check_mark: | N/A | +| `page_age` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicWebSearchResultType](../components/anthropicwebsearchresulttype.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchresultblockparam.mdx b/docs/components/anthropicwebsearchresultblockparam.mdx index 0da915149..ddcfad396 100644 --- a/docs/components/anthropicwebsearchresultblockparam.mdx +++ b/docs/components/anthropicwebsearchresultblockparam.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchResultBlockParam" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `encrypted_content` | *str* | ✅ | N/A | -| `page_age` | *OptionalNullable[str]* | ➖ | N/A | -| `title` | *str* | ✅ | N/A | -| `type` | [components.AnthropicWebSearchResultBlockParamType](../components/anthropicwebsearchresultblockparamtype.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `encrypted_content` | *str* | :heavy_check_mark: | N/A | +| `page_age` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicWebSearchResultBlockParamType](../components/anthropicwebsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchtoolresult.mdx b/docs/components/anthropicwebsearchtoolresult.mdx index 1a3a9898c..52ae78a27 100644 --- a/docs/components/anthropicwebsearchtoolresult.mdx +++ b/docs/components/anthropicwebsearchtoolresult.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | -| `content` | [components.AnthropicWebSearchToolResultContent](../components/anthropicwebsearchtoolresultcontent.mdx) | ✅ | N/A | | -| `tool_use_id` | *str* | ✅ | N/A | | -| `type` | [components.AnthropicWebSearchToolResultType](../components/anthropicwebsearchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | +| `content` | [components.AnthropicWebSearchToolResultContent](../components/anthropicwebsearchtoolresultcontent.mdx) | :heavy_check_mark: | N/A | | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.AnthropicWebSearchToolResultType](../components/anthropicwebsearchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchtoolresulterror.mdx b/docs/components/anthropicwebsearchtoolresulterror.mdx index 6659aefb1..7b7cb1372 100644 --- a/docs/components/anthropicwebsearchtoolresulterror.mdx +++ b/docs/components/anthropicwebsearchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicWebSearchToolResultError" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `error_code` | [components.AnthropicWebSearchToolResultErrorErrorCode](../components/anthropicwebsearchtoolresulterrorerrorcode.mdx) | ✅ | N/A | -| `type` | [components.AnthropicWebSearchToolResultErrorType](../components/anthropicwebsearchtoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `error_code` | [components.AnthropicWebSearchToolResultErrorErrorCode](../components/anthropicwebsearchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.AnthropicWebSearchToolResultErrorType](../components/anthropicwebsearchtoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchtooluserlocation.mdx b/docs/components/anthropicwebsearchtooluserlocation.mdx index cc8014ba5..0096c9dc4 100644 --- a/docs/components/anthropicwebsearchtooluserlocation.mdx +++ b/docs/components/anthropicwebsearchtooluserlocation.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchToolUserLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `city` | *OptionalNullable[str]* | ➖ | N/A | -| `country` | *OptionalNullable[str]* | ➖ | N/A | -| `region` | *OptionalNullable[str]* | ➖ | N/A | -| `timezone` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.AnthropicWebSearchToolUserLocationType](../components/anthropicwebsearchtooluserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.AnthropicWebSearchToolUserLocationType](../components/anthropicwebsearchtooluserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/applypatchcallitem.mdx b/docs/components/applypatchcallitem.mdx index 07943aac8..69bc2b864 100644 --- a/docs/components/applypatchcallitem.mdx +++ b/docs/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 | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `operation` | [components.ApplyPatchCallOperation](../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](../components/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | [components.ApplyPatchCallItemType](../components/applypatchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `operation` | [components.ApplyPatchCallOperation](../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](../components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | +| `type` | [components.ApplyPatchCallItemType](../components/applypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/applypatchcalloperationdiffdeltaevent.mdx b/docs/components/applypatchcalloperationdiffdeltaevent.mdx index 5f0581c56..d8c4af6ac 100644 --- a/docs/components/applypatchcalloperationdiffdeltaevent.mdx +++ b/docs/components/applypatchcalloperationdiffdeltaevent.mdx @@ -9,8 +9,8 @@ Incremental chunk of `operation.diff` for an `apply_patch_call`. Matches OpenAI' | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `delta` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../components/applypatchcalloperationdiffdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../components/applypatchcalloperationdiffdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/applypatchcalloperationdiffdoneevent.mdx b/docs/components/applypatchcalloperationdiffdoneevent.mdx index 44a387527..c722bd495 100644 --- a/docs/components/applypatchcalloperationdiffdoneevent.mdx +++ b/docs/components/applypatchcalloperationdiffdoneevent.mdx @@ -9,8 +9,8 @@ Emitted when `operation.diff` streaming completes for an `apply_patch_call`. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `diff` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ApplyPatchCallOperationDiffDoneEventType](../components/applypatchcalloperationdiffdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `diff` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ApplyPatchCallOperationDiffDoneEventType](../components/applypatchcalloperationdiffdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/applypatchcalloutputitem.mdx b/docs/components/applypatchcalloutputitem.mdx index 4195ba13c..6ef61a86a 100644 --- a/docs/components/applypatchcalloutputitem.mdx +++ b/docs/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 | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `call_id` | *str* | ✅ | N/A | -| `id` | *OptionalNullable[str]* | ➖ | N/A | -| `output` | *OptionalNullable[str]* | ➖ | N/A | -| `status` | [components.ApplyPatchCallOutputItemStatus](../components/applypatchcalloutputitemstatus.mdx) | ✅ | N/A | -| `type` | [components.ApplyPatchCallOutputItemType](../components/applypatchcalloutputitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `output` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `status` | [components.ApplyPatchCallOutputItemStatus](../components/applypatchcalloutputitemstatus.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.ApplyPatchCallOutputItemType](../components/applypatchcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/applypatchcreatefileoperation.mdx b/docs/components/applypatchcreatefileoperation.mdx index 54000e705..37aa1921b 100644 --- a/docs/components/applypatchcreatefileoperation.mdx +++ b/docs/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` | *str* | ✅ | N/A | -| `path` | *str* | ✅ | N/A | -| `type` | [components.ApplyPatchCreateFileOperationType](../components/applypatchcreatefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `diff` | *str* | :heavy_check_mark: | N/A | +| `path` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ApplyPatchCreateFileOperationType](../components/applypatchcreatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/applypatchdeletefileoperation.mdx b/docs/components/applypatchdeletefileoperation.mdx index 5c398f64a..49463ffa8 100644 --- a/docs/components/applypatchdeletefileoperation.mdx +++ b/docs/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` | *str* | ✅ | N/A | -| `type` | [components.ApplyPatchDeleteFileOperationType](../components/applypatchdeletefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `path` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ApplyPatchDeleteFileOperationType](../components/applypatchdeletefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/applypatchservertool.mdx b/docs/components/applypatchservertool.mdx index 63069c30e..b8c80524b 100644 --- a/docs/components/applypatchservertool.mdx +++ b/docs/components/applypatchservertool.mdx @@ -9,4 +9,4 @@ Apply patch tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.ApplyPatchServerToolType](../components/applypatchservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.ApplyPatchServerToolType](../components/applypatchservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/applypatchservertoolconfig.mdx b/docs/components/applypatchservertoolconfig.mdx index b8aa5b714..1ec1793d3 100644 --- a/docs/components/applypatchservertoolconfig.mdx +++ b/docs/components/applypatchservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:apply_patch server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [Optional[components.ApplyPatchEngineEnum]](../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` | [Optional[components.ApplyPatchEngineEnum]](../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/components/applypatchservertoolopenrouter.mdx b/docs/components/applypatchservertoolopenrouter.mdx index b4bfb5e5f..98531bfb7 100644 --- a/docs/components/applypatchservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.ApplyPatchServerToolConfig]](../components/applypatchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | -| `type` | [components.ApplyPatchServerToolOpenRouterType](../components/applypatchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.ApplyPatchServerToolConfig]](../components/applypatchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | +| `type` | [components.ApplyPatchServerToolOpenRouterType](../components/applypatchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/applypatchupdatefileoperation.mdx b/docs/components/applypatchupdatefileoperation.mdx index 2a31fac7c..458f78672 100644 --- a/docs/components/applypatchupdatefileoperation.mdx +++ b/docs/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` | *str* | ✅ | N/A | -| `path` | *str* | ✅ | N/A | -| `type` | [components.ApplyPatchUpdateFileOperationType](../components/applypatchupdatefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `diff` | *str* | :heavy_check_mark: | N/A | +| `path` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ApplyPatchUpdateFileOperationType](../components/applypatchupdatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/apprankingsitem.mdx b/docs/components/apprankingsitem.mdx index 996f21627..08cc35c0a 100644 --- a/docs/components/apprankingsitem.mdx +++ b/docs/components/apprankingsitem.mdx @@ -6,8 +6,8 @@ title: "AppRankingsItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `app_id` | *int* | ✅ | Stable numeric identifier of the app on OpenRouter. | 12345 | -| `app_name` | *str* | ✅ | Public display name of the app. | Cline | -| `rank` | *int* | ✅ | 1-based position of the app within this response, per the requested `sort`. | 1 | -| `total_requests` | *int* | ✅ | Number of requests attributed to the app inside the date window. | 4321 | -| `total_tokens` | *str* | ✅ | 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 +| `app_id` | *int* | :heavy_check_mark: | Stable numeric identifier of the app on OpenRouter. | 12345 | +| `app_name` | *str* | :heavy_check_mark: | Public display name of the app. | Cline | +| `rank` | *int* | :heavy_check_mark: | 1-based position of the app within this response, per the requested `sort`. | 1 | +| `total_requests` | *int* | :heavy_check_mark: | Number of requests attributed to the app inside the date window. | 4321 | +| `total_tokens` | *str* | :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/components/apprankingsresponse.mdx b/docs/components/apprankingsresponse.mdx index b3486dca4..dd7310f00 100644 --- a/docs/components/apprankingsresponse.mdx +++ b/docs/components/apprankingsresponse.mdx @@ -6,5 +6,5 @@ title: "AppRankingsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | List[[components.AppRankingsItem](../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](../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` | List[[components.AppRankingsItem](../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](../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/components/architecture.mdx b/docs/components/architecture.mdx index 953efa605..1c451e3fe 100644 --- a/docs/components/architecture.mdx +++ b/docs/components/architecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `input_modalities` | List[[components.InputModality](../components/inputmodality.mdx)] | ✅ | Supported input modalities | | -| `instruct_type` | [Nullable[components.InstructType]](../components/instructtype.mdx) | ✅ | Instruction format type | chatml | -| `modality` | *Nullable[str]* | ✅ | Primary modality of the model | text | -| `output_modalities` | List[[components.OutputModality](../components/outputmodality.mdx)] | ✅ | Supported output modalities | | -| `tokenizer` | [Nullable[components.ModelGroup]](../components/modelgroup.mdx) | ✅ | N/A | GPT | \ No newline at end of file +| `input_modalities` | List[[components.InputModality](../components/inputmodality.mdx)] | :heavy_check_mark: | Supported input modalities | | +| `instruct_type` | [Nullable[components.InstructType]](../components/instructtype.mdx) | :heavy_check_mark: | Instruction format type | chatml | +| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text | +| `output_modalities` | List[[components.OutputModality](../components/outputmodality.mdx)] | :heavy_check_mark: | Supported output modalities | | +| `tokenizer` | [Nullable[components.ModelGroup]](../components/modelgroup.mdx) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file diff --git a/docs/components/audiourl.mdx b/docs/components/audiourl.mdx index 2a5d649d0..ef98b1de4 100644 --- a/docs/components/audiourl.mdx +++ b/docs/components/audiourl.mdx @@ -6,4 +6,4 @@ title: "AudioURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/autobetarouterplugin.mdx b/docs/components/autobetarouterplugin.mdx index 4a844e501..d361141a0 100644 --- a/docs/components/autobetarouterplugin.mdx +++ b/docs/components/autobetarouterplugin.mdx @@ -6,9 +6,9 @@ title: "AutoBetaRouterPlugin" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | ➖ | 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/*"
] | -| ~~`cost_quality_tradeoff`~~ | *Optional[int]* | ➖ | : 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 | -| `cost_tier` | [Optional[components.AutoBetaRouterPluginCostTier]](../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` | *Optional[bool]* | ➖ | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | -| `excluded_models` | List[*str*] | ➖ | 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](../components/autobetarouterpluginid.mdx) | ✅ | N/A | | \ No newline at end of file +| `allowed_models` | List[*str*] | :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/*"
] | +| ~~`cost_quality_tradeoff`~~ | *Optional[int]* | :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 | +| `cost_tier` | [Optional[components.AutoBetaRouterPluginCostTier]](../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` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | +| `excluded_models` | List[*str*] | :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](../components/autobetarouterpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/autorouterplugin.mdx b/docs/components/autorouterplugin.mdx index 6a9ad0505..682200794 100644 --- a/docs/components/autorouterplugin.mdx +++ b/docs/components/autorouterplugin.mdx @@ -6,10 +6,10 @@ title: "AutoRouterPlugin" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | ➖ | 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/*"
] | -| ~~`cost_quality_tradeoff`~~ | *Optional[int]* | ➖ | : 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 | -| `cost_tier` | [Optional[components.AutoRouterPluginCostTier]](../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` | *Optional[bool]* | ➖ | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `excluded_models` | List[*str*] | ➖ | 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](../components/autorouterpluginid.mdx) | ✅ | N/A | | -| `pin_model` | *Optional[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 +| `allowed_models` | List[*str*] | :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/*"
] | +| ~~`cost_quality_tradeoff`~~ | *Optional[int]* | :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 | +| `cost_tier` | [Optional[components.AutoRouterPluginCostTier]](../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` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | +| `excluded_models` | List[*str*] | :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](../components/autorouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `pin_model` | *Optional[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/components/badgatewayresponseerrordata.mdx b/docs/components/badgatewayresponseerrordata.mdx index 5c9efedb5..2a37f6808 100644 --- a/docs/components/badgatewayresponseerrordata.mdx +++ b/docs/components/badgatewayresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for BadGatewayResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/badrequestresponseerrordata.mdx b/docs/components/badrequestresponseerrordata.mdx index da9f6a079..3fa8d9508 100644 --- a/docs/components/badrequestresponseerrordata.mdx +++ b/docs/components/badrequestresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for BadRequestResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/baseinputsmessage.mdx b/docs/components/baseinputsmessage.mdx index 9b21b0026..0c00444a9 100644 --- a/docs/components/baseinputsmessage.mdx +++ b/docs/components/baseinputsmessage.mdx @@ -6,7 +6,7 @@ title: "BaseInputsMessage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content` | [components.BaseInputsContent2](../components/baseinputscontent2.mdx) | ✅ | N/A | -| `phase` | [OptionalNullable[components.BaseInputsPhaseUnion]](../components/baseinputsphaseunion.mdx) | ➖ | N/A | -| `role` | [components.BaseInputsRoleUnion](../components/baseinputsroleunion.mdx) | ✅ | N/A | -| `type` | [Optional[components.BaseInputsType]](../components/baseinputstype.mdx) | ➖ | N/A | \ No newline at end of file +| `content` | [components.BaseInputsContent2](../components/baseinputscontent2.mdx) | :heavy_check_mark: | N/A | +| `phase` | [OptionalNullable[components.BaseInputsPhaseUnion]](../components/baseinputsphaseunion.mdx) | :heavy_minus_sign: | N/A | +| `role` | [components.BaseInputsRoleUnion](../components/baseinputsroleunion.mdx) | :heavy_check_mark: | N/A | +| `type` | [Optional[components.BaseInputsType]](../components/baseinputstype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/basereasoningconfig.mdx b/docs/components/basereasoningconfig.mdx index 4e05525ed..6f900a92f 100644 --- a/docs/components/basereasoningconfig.mdx +++ b/docs/components/basereasoningconfig.mdx @@ -6,7 +6,7 @@ title: "BaseReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context` | [OptionalNullable[components.ReasoningContext]](../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[components.ReasoningEffort]](../components/reasoningeffort.mdx) | ➖ | N/A | medium | -| `mode` | [OptionalNullable[components.ReasoningMode]](../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[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.mdx) | ➖ | N/A | auto | \ No newline at end of file +| `context` | [OptionalNullable[components.ReasoningContext]](../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[components.ReasoningEffort]](../components/reasoningeffort.mdx) | :heavy_minus_sign: | N/A | medium | +| `mode` | [OptionalNullable[components.ReasoningMode]](../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[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.mdx) | :heavy_minus_sign: | N/A | auto | \ No newline at end of file diff --git a/docs/components/bashservertool.mdx b/docs/components/bashservertool.mdx index 3727711ec..09464da84 100644 --- a/docs/components/bashservertool.mdx +++ b/docs/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` | [Optional[components.BashServerToolConfig]](../components/bashservertoolconfig.mdx) | ➖ | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | -| `type` | [components.BashServerToolType](../components/bashservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.BashServerToolConfig]](../components/bashservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | +| `type` | [components.BashServerToolType](../components/bashservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/bashservertoolconfig.mdx b/docs/components/bashservertoolconfig.mdx index 74532a4fd..8fba79f13 100644 --- a/docs/components/bashservertoolconfig.mdx +++ b/docs/components/bashservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:bash server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [Optional[components.BashServerToolEngine]](../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` | [Optional[components.BashServerToolEnvironment]](../components/bashservertoolenvironment.mdx) | ➖ | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | \ No newline at end of file +| `engine` | [Optional[components.BashServerToolEngine]](../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` | [Optional[components.BashServerToolEnvironment]](../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/components/batchdeletedobject.mdx b/docs/components/batchdeletedobject.mdx index 3fe356bdb..9c7da3ad2 100644 --- a/docs/components/batchdeletedobject.mdx +++ b/docs/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](../components/batchdeletiontargets.mdx) | ✅ | OpenRouter cleanup and, when a provider was assigned, the upstream batch deletion outcome. | \{
"openrouter": "deleted",
"upstream": \{
"provider": "Anthropic",
"status": "deleted"
}
} | -| `id` | *str* | ✅ | N/A | batch_abc123 | -| `object` | [components.BatchDeletedObjectObject](../components/batchdeletedobjectobject.mdx) | ✅ | N/A | | \ No newline at end of file +| `deletion` | [components.BatchDeletionTargets](../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` | *str* | :heavy_check_mark: | N/A | batch_abc123 | +| `object` | [components.BatchDeletedObjectObject](../components/batchdeletedobjectobject.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/batchdeletiontargets.mdx b/docs/components/batchdeletiontargets.mdx index 4a99b661e..70b3c642c 100644 --- a/docs/components/batchdeletiontargets.mdx +++ b/docs/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](../components/openrouter.mdx) | ✅ | OpenRouter-held request and result artifacts were purged. | -| `upstream` | [Optional[components.Upstream]](../components/upstream.mdx) | ➖ | The upstream batch deletion outcome; omitted when no provider was assigned. | \ No newline at end of file +| `openrouter` | [components.Openrouter](../components/openrouter.mdx) | :heavy_check_mark: | OpenRouter-held request and result artifacts were purged. | +| `upstream` | [Optional[components.Upstream]](../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/components/batcherrorresponseerror.mdx b/docs/components/batcherrorresponseerror.mdx index 89fe9721c..230a7c61a 100644 --- a/docs/components/batcherrorresponseerror.mdx +++ b/docs/components/batcherrorresponseerror.mdx @@ -6,5 +6,5 @@ title: "BatchErrorResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchlistitem.mdx b/docs/components/batchlistitem.mdx index 25a253795..7a39aba9b 100644 --- a/docs/components/batchlistitem.mdx +++ b/docs/components/batchlistitem.mdx @@ -9,15 +9,15 @@ Metadata-only batch object. `results` is always `null` in list responses. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `completion_window` | [components.BatchListItemCompletionWindow](../components/batchlistitemcompletionwindow.mdx) | ✅ | N/A | -| `created_at` | *int* | ✅ | N/A | -| `endpoint` | *str* | ✅ | N/A | -| `error` | [Nullable[components.BatchListItemError]](../components/batchlistitemerror.mdx) | ✅ | N/A | -| `finalized_at` | *Nullable[int]* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `model` | *str* | ✅ | N/A | -| `object` | [components.BatchListItemObject](../components/batchlistitemobject.mdx) | ✅ | N/A | -| `request_counts` | [components.BatchListItemRequestCounts](../components/batchlistitemrequestcounts.mdx) | ✅ | N/A | -| `results` | *Nullable[Any]* | ✅ | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | -| `status` | [components.BatchListItemStatus](../components/batchlistitemstatus.mdx) | ✅ | N/A | -| `usage` | [Nullable[components.BatchListItemUsage]](../components/batchlistitemusage.mdx) | ✅ | N/A | \ No newline at end of file +| `completion_window` | [components.BatchListItemCompletionWindow](../components/batchlistitemcompletionwindow.mdx) | :heavy_check_mark: | N/A | +| `created_at` | *int* | :heavy_check_mark: | N/A | +| `endpoint` | *str* | :heavy_check_mark: | N/A | +| `error` | [Nullable[components.BatchListItemError]](../components/batchlistitemerror.mdx) | :heavy_check_mark: | N/A | +| `finalized_at` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | +| `object` | [components.BatchListItemObject](../components/batchlistitemobject.mdx) | :heavy_check_mark: | N/A | +| `request_counts` | [components.BatchListItemRequestCounts](../components/batchlistitemrequestcounts.mdx) | :heavy_check_mark: | N/A | +| `results` | *Nullable[Any]* | :heavy_check_mark: | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | +| `status` | [components.BatchListItemStatus](../components/batchlistitemstatus.mdx) | :heavy_check_mark: | N/A | +| `usage` | [Nullable[components.BatchListItemUsage]](../components/batchlistitemusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchlistitemcompletiontokensdetails.mdx b/docs/components/batchlistitemcompletiontokensdetails.mdx index b220f29b4..769284c9d 100644 --- a/docs/components/batchlistitemcompletiontokensdetails.mdx +++ b/docs/components/batchlistitemcompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchListItemCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/batchlistitemerror.mdx b/docs/components/batchlistitemerror.mdx index 68326f504..1891de192 100644 --- a/docs/components/batchlistitemerror.mdx +++ b/docs/components/batchlistitemerror.mdx @@ -6,4 +6,4 @@ title: "BatchListItemError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | ✅ | N/A | \ No newline at end of file +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchlistitemprompttokensdetails.mdx b/docs/components/batchlistitemprompttokensdetails.mdx index 03e67cf92..6da3113ea 100644 --- a/docs/components/batchlistitemprompttokensdetails.mdx +++ b/docs/components/batchlistitemprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/batchlistitemrequestcounts.mdx b/docs/components/batchlistitemrequestcounts.mdx index 6df200a13..695a4266b 100644 --- a/docs/components/batchlistitemrequestcounts.mdx +++ b/docs/components/batchlistitemrequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchListItemRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `completed` | *int* | ✅ | N/A | -| `failed` | *int* | ✅ | N/A | -| `total` | *int* | ✅ | N/A | \ No newline at end of file +| `completed` | *int* | :heavy_check_mark: | N/A | +| `failed` | *int* | :heavy_check_mark: | N/A | +| `total` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchlistitemservertooluse.mdx b/docs/components/batchlistitemservertooluse.mdx index 01d83c196..becd27892 100644 --- a/docs/components/batchlistitemservertooluse.mdx +++ b/docs/components/batchlistitemservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | -| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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 +| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | :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. | +| `web_search_requests` | *OptionalNullable[int]* | :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/components/batchlistitemusage.mdx b/docs/components/batchlistitemusage.mdx index c5748a98b..770b73573 100644 --- a/docs/components/batchlistitemusage.mdx +++ b/docs/components/batchlistitemusage.mdx @@ -6,16 +6,16 @@ title: "BatchListItemUsage" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completion_tokens` | *int* | ✅ | The tokens generated | | -| `completion_tokens_details` | [OptionalNullable[components.BatchListItemCompletionTokensDetails]](../components/batchlistitemcompletiontokensdetails.mdx) | ➖ | N/A | | -| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | -| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | | -| `prompt_tokens_details` | [OptionalNullable[components.BatchListItemPromptTokensDetails]](../components/batchlistitemprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | -| `server_tool_use` | [OptionalNullable[components.BatchListItemServerToolUse]](../components/batchlistitemservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | -| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | -| `total_tokens` | *int* | ✅ | Sum of the above two fields | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | | +| `completion_tokens_details` | [OptionalNullable[components.BatchListItemCompletionTokensDetails]](../components/batchlistitemcompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | +| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | +| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | | +| `prompt_tokens_details` | [OptionalNullable[components.BatchListItemPromptTokensDetails]](../components/batchlistitemprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `server_tool_use` | [OptionalNullable[components.BatchListItemServerToolUse]](../components/batchlistitemservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | +| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/components/batchlistresponse.mdx b/docs/components/batchlistresponse.mdx index fcf129f43..31a10bfb7 100644 --- a/docs/components/batchlistresponse.mdx +++ b/docs/components/batchlistresponse.mdx @@ -9,8 +9,8 @@ A newest-first page of metadata-only batch objects. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | List[[components.BatchListItem](../components/batchlistitem.mdx)] | ✅ | N/A | -| `first_id` | *Nullable[str]* | ✅ | N/A | -| `has_more` | *bool* | ✅ | N/A | -| `last_id` | *Nullable[str]* | ✅ | N/A | -| `object` | [components.BatchListResponseObject](../components/batchlistresponseobject.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.BatchListItem](../components/batchlistitem.mdx)] | :heavy_check_mark: | N/A | +| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `has_more` | *bool* | :heavy_check_mark: | N/A | +| `last_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `object` | [components.BatchListResponseObject](../components/batchlistresponseobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchobject.mdx b/docs/components/batchobject.mdx index ca69141f2..cec2c6ae6 100644 --- a/docs/components/batchobject.mdx +++ b/docs/components/batchobject.mdx @@ -6,15 +6,15 @@ title: "BatchObject" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `completion_window` | [components.BatchObjectCompletionWindow](../components/batchobjectcompletionwindow.mdx) | ✅ | N/A | -| `created_at` | *int* | ✅ | N/A | -| `endpoint` | *str* | ✅ | N/A | -| `error` | [Nullable[components.BatchObjectError]](../components/batchobjecterror.mdx) | ✅ | N/A | -| `finalized_at` | *Nullable[int]* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `model` | *str* | ✅ | N/A | -| `object` | [components.BatchObjectObjectBatch](../components/batchobjectobjectbatch.mdx) | ✅ | N/A | -| `request_counts` | [components.BatchObjectRequestCounts](../components/batchobjectrequestcounts.mdx) | ✅ | N/A | -| `results` | List[[components.Result](../components/result.mdx)] | ✅ | N/A | -| `status` | [components.BatchObjectStatus](../components/batchobjectstatus.mdx) | ✅ | N/A | -| `usage` | [Nullable[components.BatchObjectUsage]](../components/batchobjectusage.mdx) | ✅ | N/A | \ No newline at end of file +| `completion_window` | [components.BatchObjectCompletionWindow](../components/batchobjectcompletionwindow.mdx) | :heavy_check_mark: | N/A | +| `created_at` | *int* | :heavy_check_mark: | N/A | +| `endpoint` | *str* | :heavy_check_mark: | N/A | +| `error` | [Nullable[components.BatchObjectError]](../components/batchobjecterror.mdx) | :heavy_check_mark: | N/A | +| `finalized_at` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | +| `object` | [components.BatchObjectObjectBatch](../components/batchobjectobjectbatch.mdx) | :heavy_check_mark: | N/A | +| `request_counts` | [components.BatchObjectRequestCounts](../components/batchobjectrequestcounts.mdx) | :heavy_check_mark: | N/A | +| `results` | List[[components.Result](../components/result.mdx)] | :heavy_check_mark: | N/A | +| `status` | [components.BatchObjectStatus](../components/batchobjectstatus.mdx) | :heavy_check_mark: | N/A | +| `usage` | [Nullable[components.BatchObjectUsage]](../components/batchobjectusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectcompletiontokensdetails.mdx b/docs/components/batchobjectcompletiontokensdetails.mdx index 77ef17c29..e9374e708 100644 --- a/docs/components/batchobjectcompletiontokensdetails.mdx +++ b/docs/components/batchobjectcompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchObjectCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/batchobjectdata.mdx b/docs/components/batchobjectdata.mdx index eb9bef7cf..9fab2e053 100644 --- a/docs/components/batchobjectdata.mdx +++ b/docs/components/batchobjectdata.mdx @@ -9,6 +9,6 @@ A single embedding object | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `embedding` | [components.Embedding](../components/embedding.mdx) | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `index` | *Optional[int]* | ➖ | Index of the embedding in the input list | 0 | -| `object` | [components.ObjectEmbedding](../components/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file +| `embedding` | [components.Embedding](../components/embedding.mdx) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the embedding in the input list | 0 | +| `object` | [components.ObjectEmbedding](../components/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/batchobjectdebug.mdx b/docs/components/batchobjectdebug.mdx index 8c26216a2..2c534c626 100644 --- a/docs/components/batchobjectdebug.mdx +++ b/docs/components/batchobjectdebug.mdx @@ -6,6 +6,6 @@ title: "BatchObjectDebug" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `echo_upstream_body` | Dict[str, *Any*] | ➖ | N/A | -| `timings` | [Optional[components.BatchObjectTimings]](../components/batchobjecttimings.mdx) | ➖ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `echo_upstream_body` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `timings` | [Optional[components.BatchObjectTimings]](../components/batchobjecttimings.mdx) | :heavy_minus_sign: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjecterror.mdx b/docs/components/batchobjecterror.mdx index 659fc8654..ae47da322 100644 --- a/docs/components/batchobjecterror.mdx +++ b/docs/components/batchobjecterror.mdx @@ -6,4 +6,4 @@ title: "BatchObjectError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | ✅ | N/A | \ No newline at end of file +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectfile.mdx b/docs/components/batchobjectfile.mdx index 77854ee87..497b24366 100644 --- a/docs/components/batchobjectfile.mdx +++ b/docs/components/batchobjectfile.mdx @@ -6,6 +6,6 @@ title: "BatchObjectFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `content` | List[[components.AnnotationContentUnion](../components/annotationcontentunion.mdx)] | ✅ | N/A | -| `hash` | *str* | ✅ | N/A | -| `name` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `content` | List[[components.AnnotationContentUnion](../components/annotationcontentunion.mdx)] | :heavy_check_mark: | N/A | +| `hash` | *str* | :heavy_check_mark: | N/A | +| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectfunction.mdx b/docs/components/batchobjectfunction.mdx index 42e373770..0a854d990 100644 --- a/docs/components/batchobjectfunction.mdx +++ b/docs/components/batchobjectfunction.mdx @@ -6,5 +6,5 @@ title: "BatchObjectFunction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `arguments` | *str* | ✅ | N/A | -| `name` | *str* | ✅ | N/A | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectimageurl.mdx b/docs/components/batchobjectimageurl.mdx index 48acabfce..70172ed5a 100644 --- a/docs/components/batchobjectimageurl.mdx +++ b/docs/components/batchobjectimageurl.mdx @@ -6,4 +6,4 @@ title: "BatchObjectImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectprompttokensdetails.mdx b/docs/components/batchobjectprompttokensdetails.mdx index 975bcfdb4..1bbcffd3a 100644 --- a/docs/components/batchobjectprompttokensdetails.mdx +++ b/docs/components/batchobjectprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/batchobjectrequestcounts.mdx b/docs/components/batchobjectrequestcounts.mdx index f4eb23219..cc180f2e5 100644 --- a/docs/components/batchobjectrequestcounts.mdx +++ b/docs/components/batchobjectrequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchObjectRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `completed` | *int* | ✅ | N/A | -| `failed` | *int* | ✅ | N/A | -| `total` | *int* | ✅ | N/A | \ No newline at end of file +| `completed` | *int* | :heavy_check_mark: | N/A | +| `failed` | *int* | :heavy_check_mark: | N/A | +| `total` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectresponse.mdx b/docs/components/batchobjectresponse.mdx index 81e9a03a4..2c8c03049 100644 --- a/docs/components/batchobjectresponse.mdx +++ b/docs/components/batchobjectresponse.mdx @@ -6,6 +6,6 @@ title: "BatchObjectResponse" | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `body` | [components.Body](../components/body.mdx) | ✅ | N/A | -| `request_id` | *Nullable[str]* | ✅ | N/A | -| `status_code` | *int* | ✅ | N/A | \ No newline at end of file +| `body` | [components.Body](../components/body.mdx) | :heavy_check_mark: | N/A | +| `request_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectservertooluse.mdx b/docs/components/batchobjectservertooluse.mdx index 1e7335957..86a211192 100644 --- a/docs/components/batchobjectservertooluse.mdx +++ b/docs/components/batchobjectservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | -| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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 +| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | :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. | +| `web_search_requests` | *OptionalNullable[int]* | :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/components/batchobjectservertoolusedetails.mdx b/docs/components/batchobjectservertoolusedetails.mdx index 42c5a669f..2ba9abb72 100644 --- a/docs/components/batchobjectservertoolusedetails.mdx +++ b/docs/components/batchobjectservertoolusedetails.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | -| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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 +| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | :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. | +| `web_search_requests` | *OptionalNullable[int]* | :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/components/batchobjecttimings.mdx b/docs/components/batchobjecttimings.mdx index 06298ae2b..528b987df 100644 --- a/docs/components/batchobjecttimings.mdx +++ b/docs/components/batchobjecttimings.mdx @@ -6,6 +6,6 @@ title: "BatchObjectTimings" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `epoch_ms` | *int* | ✅ | N/A | -| `event` | [components.BatchObjectEvent](../components/batchobjectevent.mdx) | ✅ | N/A | -| `start_ms` | *int* | ✅ | N/A | \ No newline at end of file +| `epoch_ms` | *int* | :heavy_check_mark: | N/A | +| `event` | [components.BatchObjectEvent](../components/batchobjectevent.mdx) | :heavy_check_mark: | N/A | +| `start_ms` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjecturlcitation.mdx b/docs/components/batchobjecturlcitation.mdx index 1fe73084b..41036e478 100644 --- a/docs/components/batchobjecturlcitation.mdx +++ b/docs/components/batchobjecturlcitation.mdx @@ -6,8 +6,8 @@ title: "BatchObjectURLCitation" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `content` | *Optional[str]* | ➖ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `title` | *str* | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectusage.mdx b/docs/components/batchobjectusage.mdx index 82a90236f..6fc6121a1 100644 --- a/docs/components/batchobjectusage.mdx +++ b/docs/components/batchobjectusage.mdx @@ -6,16 +6,16 @@ title: "BatchObjectUsage" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completion_tokens` | *int* | ✅ | The tokens generated | | -| `completion_tokens_details` | [OptionalNullable[components.BatchObjectCompletionTokensDetails]](../components/batchobjectcompletiontokensdetails.mdx) | ➖ | N/A | | -| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | -| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | | -| `prompt_tokens_details` | [OptionalNullable[components.BatchObjectPromptTokensDetails]](../components/batchobjectprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | -| `server_tool_use` | [OptionalNullable[components.BatchObjectServerToolUse]](../components/batchobjectservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | -| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | -| `total_tokens` | *int* | ✅ | Sum of the above two fields | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | | +| `completion_tokens_details` | [OptionalNullable[components.BatchObjectCompletionTokensDetails]](../components/batchobjectcompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | +| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | +| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | | +| `prompt_tokens_details` | [OptionalNullable[components.BatchObjectPromptTokensDetails]](../components/batchobjectprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `server_tool_use` | [OptionalNullable[components.BatchObjectServerToolUse]](../components/batchobjectservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | +| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx b/docs/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx index 394a8cd68..02caac2a1 100644 --- a/docs/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx +++ b/docs/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchPaymentRequiredResponseCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponseerror.mdx b/docs/components/batchpaymentrequiredresponseerror.mdx index de630aaf9..e07f3accb 100644 --- a/docs/components/batchpaymentrequiredresponseerror.mdx +++ b/docs/components/batchpaymentrequiredresponseerror.mdx @@ -6,5 +6,5 @@ title: "BatchPaymentRequiredResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponseprompttokensdetails.mdx b/docs/components/batchpaymentrequiredresponseprompttokensdetails.mdx index fe6816daa..bc41b3015 100644 --- a/docs/components/batchpaymentrequiredresponseprompttokensdetails.mdx +++ b/docs/components/batchpaymentrequiredresponseprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponserequestcounts.mdx b/docs/components/batchpaymentrequiredresponserequestcounts.mdx index 6c9bad545..66d9b4839 100644 --- a/docs/components/batchpaymentrequiredresponserequestcounts.mdx +++ b/docs/components/batchpaymentrequiredresponserequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchPaymentRequiredResponseRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `completed` | *int* | ✅ | N/A | -| `failed` | *int* | ✅ | N/A | -| `total` | *int* | ✅ | N/A | \ No newline at end of file +| `completed` | *int* | :heavy_check_mark: | N/A | +| `failed` | *int* | :heavy_check_mark: | N/A | +| `total` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponseservertooluse.mdx b/docs/components/batchpaymentrequiredresponseservertooluse.mdx index fbab119fc..907e46609 100644 --- a/docs/components/batchpaymentrequiredresponseservertooluse.mdx +++ b/docs/components/batchpaymentrequiredresponseservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | -| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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 +| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | :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. | +| `web_search_requests` | *OptionalNullable[int]* | :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/components/batchpaymentrequiredresponseusage.mdx b/docs/components/batchpaymentrequiredresponseusage.mdx index daf6443b7..e4b28f4d5 100644 --- a/docs/components/batchpaymentrequiredresponseusage.mdx +++ b/docs/components/batchpaymentrequiredresponseusage.mdx @@ -6,16 +6,16 @@ title: "BatchPaymentRequiredResponseUsage" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completion_tokens` | *int* | ✅ | The tokens generated | | -| `completion_tokens_details` | [OptionalNullable[components.BatchPaymentRequiredResponseCompletionTokensDetails]](../components/batchpaymentrequiredresponsecompletiontokensdetails.mdx) | ➖ | N/A | | -| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | -| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | | -| `prompt_tokens_details` | [OptionalNullable[components.BatchPaymentRequiredResponsePromptTokensDetails]](../components/batchpaymentrequiredresponseprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | -| `server_tool_use` | [OptionalNullable[components.BatchPaymentRequiredResponseServerToolUse]](../components/batchpaymentrequiredresponseservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | -| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | -| `total_tokens` | *int* | ✅ | Sum of the above two fields | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | | +| `completion_tokens_details` | [OptionalNullable[components.BatchPaymentRequiredResponseCompletionTokensDetails]](../components/batchpaymentrequiredresponsecompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | +| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | +| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | | +| `prompt_tokens_details` | [OptionalNullable[components.BatchPaymentRequiredResponsePromptTokensDetails]](../components/batchpaymentrequiredresponseprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `server_tool_use` | [OptionalNullable[components.BatchPaymentRequiredResponseServerToolUse]](../components/batchpaymentrequiredresponseservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | +| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/components/batchproviderpreferences.mdx b/docs/components/batchproviderpreferences.mdx index d7ba53e63..f3a21d140 100644 --- a/docs/components/batchproviderpreferences.mdx +++ b/docs/components/batchproviderpreferences.mdx @@ -9,5 +9,5 @@ Batch provider routing preferences. Only `provider.only` and `provider.allow_fal | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allow_fallbacks` | *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` | List[[components.BatchProviderPreferencesOnly](../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 +| `allow_fallbacks` | *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` | List[[components.BatchProviderPreferencesOnly](../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/components/batchsubmitbody.mdx b/docs/components/batchsubmitbody.mdx index f6af1fb5b..5f85713cf 100644 --- a/docs/components/batchsubmitbody.mdx +++ b/docs/components/batchsubmitbody.mdx @@ -9,8 +9,8 @@ Batch submit request body. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `completion_window` | [Optional[components.BatchSubmitBodyCompletionWindow]](../components/batchsubmitbodycompletionwindow.mdx) | ➖ | N/A | | -| `endpoint` | [components.Endpoint](../components/endpoint.mdx) | ✅ | N/A | | -| `model` | *str* | ✅ | N/A | | -| `provider` | [OptionalNullable[components.BatchProviderPreferences]](../components/batchproviderpreferences.mdx) | ➖ | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | -| `requests` | List[[components.Request](../components/request.mdx)] | ✅ | N/A | | \ No newline at end of file +| `completion_window` | [Optional[components.BatchSubmitBodyCompletionWindow]](../components/batchsubmitbodycompletionwindow.mdx) | :heavy_minus_sign: | N/A | | +| `endpoint` | [components.Endpoint](../components/endpoint.mdx) | :heavy_check_mark: | N/A | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `provider` | [OptionalNullable[components.BatchProviderPreferences]](../components/batchproviderpreferences.mdx) | :heavy_minus_sign: | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | +| `requests` | List[[components.Request](../components/request.mdx)] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/bodychatcompletion.mdx b/docs/components/bodychatcompletion.mdx index ff3bd7cad..268627065 100644 --- a/docs/components/bodychatcompletion.mdx +++ b/docs/components/bodychatcompletion.mdx @@ -6,15 +6,15 @@ title: "BodyChatCompletion" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alignment` | [Optional[components.Alignment]](../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` | List[[components.Choice](../components/choice.mdx)] | ✅ | N/A | | -| `created` | *int* | ✅ | N/A | | -| `debug` | [Optional[components.BatchObjectDebug]](../components/batchobjectdebug.mdx) | ➖ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `model` | *str* | ✅ | N/A | | -| `object` | [components.BodyObjectChatCompletion](../components/bodyobjectchatcompletion.mdx) | ✅ | N/A | | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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[str]* | ➖ | N/A | | -| `service_tier` | *OptionalNullable[str]* | ➖ | N/A | | -| `system_fingerprint` | *OptionalNullable[str]* | ➖ | N/A | | -| `usage` | [Optional[components.BodyUsage1]](../components/bodyusage1.mdx) | ➖ | N/A | | \ No newline at end of file +| `alignment` | [Optional[components.Alignment]](../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` | List[[components.Choice](../components/choice.mdx)] | :heavy_check_mark: | N/A | | +| `created` | *int* | :heavy_check_mark: | N/A | | +| `debug` | [Optional[components.BatchObjectDebug]](../components/batchobjectdebug.mdx) | :heavy_minus_sign: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `object` | [components.BodyObjectChatCompletion](../components/bodyobjectchatcompletion.mdx) | :heavy_check_mark: | N/A | | +| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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[str]* | :heavy_minus_sign: | N/A | | +| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `usage` | [Optional[components.BodyUsage1]](../components/bodyusage1.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/bodycompletiontokensdetails.mdx b/docs/components/bodycompletiontokensdetails.mdx index 69b8630eb..903c963ca 100644 --- a/docs/components/bodycompletiontokensdetails.mdx +++ b/docs/components/bodycompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BodyCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/bodylist.mdx b/docs/components/bodylist.mdx index f5a5048ac..2cd0a5e7b 100644 --- a/docs/components/bodylist.mdx +++ b/docs/components/bodylist.mdx @@ -9,8 +9,8 @@ Embeddings response containing embedding vectors | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | List[[components.BatchObjectData](../components/batchobjectdata.mdx)] | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `id` | *Optional[str]* | ➖ | Unique identifier for the embeddings response | embd-1234567890 | -| `model` | *str* | ✅ | The model used for embeddings | openai/text-embedding-3-small | -| `object` | [components.BodyObjectList](../components/bodyobjectlist.mdx) | ✅ | N/A | | -| `usage` | [Optional[components.BodyUsage3]](../components/bodyusage3.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `data` | List[[components.BatchObjectData](../components/batchobjectdata.mdx)] | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | +| `model` | *str* | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | +| `object` | [components.BodyObjectList](../components/bodyobjectlist.mdx) | :heavy_check_mark: | N/A | | +| `usage` | [Optional[components.BodyUsage3]](../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/components/bodymessage.mdx b/docs/components/bodymessage.mdx index 785e9f2c3..92a8aa873 100644 --- a/docs/components/bodymessage.mdx +++ b/docs/components/bodymessage.mdx @@ -6,14 +6,14 @@ title: "BodyMessage" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container` | [Nullable[components.AnthropicContainer]](../components/anthropiccontainer.mdx) | ✅ | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | -| `content` | List[[components.ORAnthropicContentBlock](../components/oranthropiccontentblock.mdx)] | ✅ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `input_transformations` | List[[components.AnthropicInputTransformation](../components/anthropicinputtransformation.mdx)] | ➖ | N/A | | -| `model` | *str* | ✅ | N/A | | -| `role` | [components.BatchObjectRole](../components/batchobjectrole.mdx) | ✅ | N/A | | -| `stop_details` | [Nullable[components.AnthropicRefusalStopDetails]](../components/anthropicrefusalstopdetails.mdx) | ✅ | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | -| `stop_reason` | [Nullable[components.ORAnthropicStopReason]](../components/oranthropicstopreason.mdx) | ✅ | N/A | end_turn | -| `stop_sequence` | *Nullable[str]* | ✅ | N/A | | -| `type` | [components.BatchObjectTypeMessage](../components/batchobjecttypemessage.mdx) | ✅ | N/A | | -| `usage` | [components.BodyUsage2](../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` | [Nullable[components.AnthropicContainer]](../components/anthropiccontainer.mdx) | :heavy_check_mark: | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | +| `content` | List[[components.ORAnthropicContentBlock](../components/oranthropiccontentblock.mdx)] | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `input_transformations` | List[[components.AnthropicInputTransformation](../components/anthropicinputtransformation.mdx)] | :heavy_minus_sign: | N/A | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `role` | [components.BatchObjectRole](../components/batchobjectrole.mdx) | :heavy_check_mark: | N/A | | +| `stop_details` | [Nullable[components.AnthropicRefusalStopDetails]](../components/anthropicrefusalstopdetails.mdx) | :heavy_check_mark: | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | +| `stop_reason` | [Nullable[components.ORAnthropicStopReason]](../components/oranthropicstopreason.mdx) | :heavy_check_mark: | N/A | end_turn | +| `stop_sequence` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `type` | [components.BatchObjectTypeMessage](../components/batchobjecttypemessage.mdx) | :heavy_check_mark: | N/A | | +| `usage` | [components.BodyUsage2](../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/components/bodyprompttokensdetails1.mdx b/docs/components/bodyprompttokensdetails1.mdx index 1de48e3da..29c622415 100644 --- a/docs/components/bodyprompttokensdetails1.mdx +++ b/docs/components/bodyprompttokensdetails1.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/bodyprompttokensdetails2.mdx b/docs/components/bodyprompttokensdetails2.mdx index 2f6072187..6462670ef 100644 --- a/docs/components/bodyprompttokensdetails2.mdx +++ b/docs/components/bodyprompttokensdetails2.mdx @@ -9,8 +9,8 @@ Per-modality token breakdown. Only present when the input contains 2+ modalities | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `audio_tokens` | *Optional[int]* | ➖ | Number of audio tokens in the input | | -| `file_tokens` | *Optional[int]* | ➖ | Number of file/document tokens in the input | | -| `image_tokens` | *Optional[int]* | ➖ | Number of image tokens in the input | 258 | -| `text_tokens` | *Optional[int]* | ➖ | Number of text tokens in the input | 8 | -| `video_tokens` | *Optional[int]* | ➖ | Number of video tokens in the input | | \ No newline at end of file +| `audio_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of audio tokens in the input | | +| `file_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of file/document tokens in the input | | +| `image_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of image tokens in the input | 258 | +| `text_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of text tokens in the input | 8 | +| `video_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/components/bodyservertooluse.mdx b/docs/components/bodyservertooluse.mdx index 39af647bf..3e20a38a7 100644 --- a/docs/components/bodyservertooluse.mdx +++ b/docs/components/bodyservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | -| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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 +| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | :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. | +| `web_search_requests` | *OptionalNullable[int]* | :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/components/bodyusage1.mdx b/docs/components/bodyusage1.mdx index 4161bf32e..61f933e34 100644 --- a/docs/components/bodyusage1.mdx +++ b/docs/components/bodyusage1.mdx @@ -6,10 +6,10 @@ title: "BodyUsage1" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `completion_tokens` | *int* | ✅ | The tokens generated | -| `completion_tokens_details` | [OptionalNullable[components.BodyCompletionTokensDetails]](../components/bodycompletiontokensdetails.mdx) | ➖ | N/A | -| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | -| `prompt_tokens_details` | [OptionalNullable[components.BodyPromptTokensDetails1]](../components/bodyprompttokensdetails1.mdx) | ➖ | Breakdown of tokens used in the prompt. | -| `server_tool_use` | [OptionalNullable[components.BodyServerToolUse]](../components/bodyservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | -| `server_tool_use_details` | [OptionalNullable[components.BatchObjectServerToolUseDetails]](../components/batchobjectservertoolusedetails.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | -| `total_tokens` | *int* | ✅ | Sum of the above two fields | \ No newline at end of file +| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | +| `completion_tokens_details` | [OptionalNullable[components.BodyCompletionTokensDetails]](../components/bodycompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | +| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | +| `prompt_tokens_details` | [OptionalNullable[components.BodyPromptTokensDetails1]](../components/bodyprompttokensdetails1.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | +| `server_tool_use` | [OptionalNullable[components.BodyServerToolUse]](../components/bodyservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | +| `server_tool_use_details` | [OptionalNullable[components.BatchObjectServerToolUseDetails]](../components/batchobjectservertoolusedetails.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | +| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | \ No newline at end of file diff --git a/docs/components/bodyusage2.mdx b/docs/components/bodyusage2.mdx index c57f51128..56c99f9b1 100644 --- a/docs/components/bodyusage2.mdx +++ b/docs/components/bodyusage2.mdx @@ -6,14 +6,14 @@ title: "BodyUsage2" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `cache_creation` | [Nullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ✅ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `cache_creation_input_tokens` | *Nullable[int]* | ✅ | N/A | | -| `cache_read_input_tokens` | *Nullable[int]* | ✅ | N/A | | -| `inference_geo` | *Nullable[str]* | ✅ | N/A | | -| `input_tokens` | *int* | ✅ | N/A | | -| `output_tokens` | *int* | ✅ | N/A | | -| `output_tokens_details` | [Nullable[components.AnthropicOutputTokensDetails]](../components/anthropicoutputtokensdetails.mdx) | ✅ | N/A | \{
"thinking_tokens": 0
} | -| `server_tool_use` | [Nullable[components.AnthropicServerToolUsage]](../components/anthropicservertoolusage.mdx) | ✅ | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | -| `service_tier` | [Nullable[components.AnthropicServiceTier]](../components/anthropicservicetier.mdx) | ✅ | N/A | standard | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | \ No newline at end of file +| `cache_creation` | [Nullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_check_mark: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `cache_creation_input_tokens` | *Nullable[int]* | :heavy_check_mark: | N/A | | +| `cache_read_input_tokens` | *Nullable[int]* | :heavy_check_mark: | N/A | | +| `inference_geo` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `input_tokens` | *int* | :heavy_check_mark: | N/A | | +| `output_tokens` | *int* | :heavy_check_mark: | N/A | | +| `output_tokens_details` | [Nullable[components.AnthropicOutputTokensDetails]](../components/anthropicoutputtokensdetails.mdx) | :heavy_check_mark: | N/A | \{
"thinking_tokens": 0
} | +| `server_tool_use` | [Nullable[components.AnthropicServerToolUsage]](../components/anthropicservertoolusage.mdx) | :heavy_check_mark: | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | +| `service_tier` | [Nullable[components.AnthropicServiceTier]](../components/anthropicservicetier.mdx) | :heavy_check_mark: | N/A | standard | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | \ No newline at end of file diff --git a/docs/components/bodyusage3.mdx b/docs/components/bodyusage3.mdx index 5101a5733..9de6b2bf6 100644 --- a/docs/components/bodyusage3.mdx +++ b/docs/components/bodyusage3.mdx @@ -9,9 +9,9 @@ Token usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cost` | *Optional[float]* | ➖ | Cost of the request in credits | 0.0001 | -| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `prompt_tokens` | *int* | ✅ | Number of tokens in the input | 8 | -| `prompt_tokens_details` | [Optional[components.BodyPromptTokensDetails2]](../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. | | -| `total_tokens` | *int* | ✅ | Total number of tokens used | 8 | \ No newline at end of file +| `cost` | *Optional[float]* | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | +| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | +| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `prompt_tokens` | *int* | :heavy_check_mark: | Number of tokens in the input | 8 | +| `prompt_tokens_details` | [Optional[components.BodyPromptTokensDetails2]](../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. | | +| `total_tokens` | *int* | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/components/booleancapability.mdx b/docs/components/booleancapability.mdx index 28e674242..74ba07281 100644 --- a/docs/components/booleancapability.mdx +++ b/docs/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](../components/booleancapabilitytype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.BooleanCapabilityType](../components/booleancapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/bulkaddworkspacemembersrequest.mdx b/docs/components/bulkaddworkspacemembersrequest.mdx index 86cd8f022..677367875 100644 --- a/docs/components/bulkaddworkspacemembersrequest.mdx +++ b/docs/components/bulkaddworkspacemembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAddWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `user_ids` | List[*str*] | ✅ | 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 +| `user_ids` | List[*str*] | :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/components/bulkaddworkspacemembersresponse.mdx b/docs/components/bulkaddworkspacemembersresponse.mdx index 4082d6f62..4550429c5 100644 --- a/docs/components/bulkaddworkspacemembersresponse.mdx +++ b/docs/components/bulkaddworkspacemembersresponse.mdx @@ -6,5 +6,5 @@ title: "BulkAddWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `added_count` | *int* | ✅ | Number of workspace memberships created or updated | 2 | -| `data` | List[[components.WorkspaceMember](../components/workspacemember.mdx)] | ✅ | List of added workspace memberships | | \ No newline at end of file +| `added_count` | *int* | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | +| `data` | List[[components.WorkspaceMember](../components/workspacemember.mdx)] | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file diff --git a/docs/components/bulkassignkeysrequest.mdx b/docs/components/bulkassignkeysrequest.mdx index 94ba7f253..ce5a37d8d 100644 --- a/docs/components/bulkassignkeysrequest.mdx +++ b/docs/components/bulkassignkeysrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAssignKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `key_hashes` | List[*str*] | ✅ | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/components/bulkassignkeysresponse.mdx b/docs/components/bulkassignkeysresponse.mdx index b37655b1d..a9f54e53b 100644 --- a/docs/components/bulkassignkeysresponse.mdx +++ b/docs/components/bulkassignkeysresponse.mdx @@ -6,4 +6,4 @@ title: "BulkAssignKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `assigned_count` | *int* | ✅ | Number of keys successfully assigned | 3 | \ No newline at end of file +| `assigned_count` | *int* | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/docs/components/bulkassignmembersrequest.mdx b/docs/components/bulkassignmembersrequest.mdx index a84aa25d3..272a74b2a 100644 --- a/docs/components/bulkassignmembersrequest.mdx +++ b/docs/components/bulkassignmembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAssignMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `member_user_ids` | List[*str*] | ✅ | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `member_user_ids` | List[*str*] | :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/components/bulkassignmembersresponse.mdx b/docs/components/bulkassignmembersresponse.mdx index b388dde21..fb4f9e2b8 100644 --- a/docs/components/bulkassignmembersresponse.mdx +++ b/docs/components/bulkassignmembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkAssignMembersResponse" | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `assigned_count` | *int* | ✅ | Number of members successfully assigned | 2 | \ No newline at end of file +| `assigned_count` | *int* | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/docs/components/bulkremoveworkspacemembersrequest.mdx b/docs/components/bulkremoveworkspacemembersrequest.mdx index f016018a8..e05a95672 100644 --- a/docs/components/bulkremoveworkspacemembersrequest.mdx +++ b/docs/components/bulkremoveworkspacemembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkRemoveWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `user_ids` | List[*str*] | ✅ | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `user_ids` | List[*str*] | :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/components/bulkremoveworkspacemembersresponse.mdx b/docs/components/bulkremoveworkspacemembersresponse.mdx index 3cb793681..a4537109a 100644 --- a/docs/components/bulkremoveworkspacemembersresponse.mdx +++ b/docs/components/bulkremoveworkspacemembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkRemoveWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `removed_count` | *int* | ✅ | Number of members removed | 2 | \ No newline at end of file +| `removed_count` | *int* | :heavy_check_mark: | Number of members removed | 2 | \ No newline at end of file diff --git a/docs/components/bulkunassignkeysrequest.mdx b/docs/components/bulkunassignkeysrequest.mdx index e4196d4e4..53506dd9c 100644 --- a/docs/components/bulkunassignkeysrequest.mdx +++ b/docs/components/bulkunassignkeysrequest.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `key_hashes` | List[*str*] | ✅ | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/components/bulkunassignkeysresponse.mdx b/docs/components/bulkunassignkeysresponse.mdx index 146bba3ae..efa2bc14b 100644 --- a/docs/components/bulkunassignkeysresponse.mdx +++ b/docs/components/bulkunassignkeysresponse.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignKeysResponse" | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `unassigned_count` | *int* | ✅ | Number of keys successfully unassigned | 3 | \ No newline at end of file +| `unassigned_count` | *int* | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/docs/components/bulkunassignmembersrequest.mdx b/docs/components/bulkunassignmembersrequest.mdx index a71c4af19..a39b1c218 100644 --- a/docs/components/bulkunassignmembersrequest.mdx +++ b/docs/components/bulkunassignmembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `member_user_ids` | List[*str*] | ✅ | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `member_user_ids` | List[*str*] | :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/components/bulkunassignmembersresponse.mdx b/docs/components/bulkunassignmembersresponse.mdx index 23c14efc5..1907c8262 100644 --- a/docs/components/bulkunassignmembersresponse.mdx +++ b/docs/components/bulkunassignmembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignMembersResponse" | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `unassigned_count` | *int* | ✅ | Number of members successfully unassigned | 2 | \ No newline at end of file +| `unassigned_count` | *int* | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/docs/components/byokkey.mdx b/docs/components/byokkey.mdx index aa1d7a042..e68d9db48 100644 --- a/docs/components/byokkey.mdx +++ b/docs/components/byokkey.mdx @@ -6,19 +6,19 @@ title: "BYOKKey" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `allowed_models` | List[*str*] | ✅ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | ✅ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `created_at` | *str* | ✅ | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | -| `declared_region` | [Nullable[components.BYOKKeyDeclaredRegion]](../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 | -| `declared_zdr` | *Nullable[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` | *str* | ✅ | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | -| `is_byok_only` | *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 | -| `is_fallback` | *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 | -| `is_required` | *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` | *str* | ✅ | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | -| `name` | *OptionalNullable[str]* | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [components.BYOKProviderSlug](../components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `sort_order` | *int* | ✅ | Position within the provider — credentials are tried in ascending sort order. | 0 | -| `workspace_id` | *Nullable[str]* | ✅ | 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 +| `allowed_api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `allowed_models` | List[*str*] | :heavy_check_mark: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | :heavy_check_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `created_at` | *str* | :heavy_check_mark: | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | +| `declared_region` | [Nullable[components.BYOKKeyDeclaredRegion]](../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 | +| `declared_zdr` | *Nullable[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` | *str* | :heavy_check_mark: | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | +| `is_byok_only` | *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 | +| `is_fallback` | *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 | +| `is_required` | *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` | *str* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | +| `provider` | [components.BYOKProviderSlug](../components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `sort_order` | *int* | :heavy_check_mark: | Position within the provider — credentials are tried in ascending sort order. | 0 | +| `workspace_id` | *Nullable[str]* | :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/components/chatassistantimages.mdx b/docs/components/chatassistantimages.mdx index 5fa709791..fbd1a4de8 100644 --- a/docs/components/chatassistantimages.mdx +++ b/docs/components/chatassistantimages.mdx @@ -6,4 +6,4 @@ title: "ChatAssistantImages" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `image_url` | [components.ChatAssistantImagesImageURL](../components/chatassistantimagesimageurl.mdx) | ✅ | N/A | \ No newline at end of file +| `image_url` | [components.ChatAssistantImagesImageURL](../components/chatassistantimagesimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chatassistantimagesimageurl.mdx b/docs/components/chatassistantimagesimageurl.mdx index ddcf19f7d..8a36279a1 100644 --- a/docs/components/chatassistantimagesimageurl.mdx +++ b/docs/components/chatassistantimagesimageurl.mdx @@ -6,4 +6,4 @@ title: "ChatAssistantImagesImageURL" | Field | Type | Required | Description | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `url` | *str* | ✅ | URL or base64-encoded data of the generated image | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | URL or base64-encoded data of the generated image | \ No newline at end of file diff --git a/docs/components/chatassistantmessage.mdx b/docs/components/chatassistantmessage.mdx index 747e8b15b..bcd7ebd8c 100644 --- a/docs/components/chatassistantmessage.mdx +++ b/docs/components/chatassistantmessage.mdx @@ -9,13 +9,13 @@ Assistant message for requests and responses | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [Optional[components.ChatAudioOutput]](../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[components.ChatAssistantMessageContent]](../components/chatassistantmessagecontent.mdx) | ➖ | Assistant message content | | -| `images` | List[[components.ChatAssistantImages](../components/chatassistantimages.mdx)] | ➖ | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | -| `model` | *Optional[str]* | ➖ | Model that generated this assistant message | openai/gpt-4o | -| `name` | *Optional[str]* | ➖ | Optional name for the assistant | | -| `reasoning` | *OptionalNullable[str]* | ➖ | Reasoning output | | -| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.mdx)] | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | -| `refusal` | *OptionalNullable[str]* | ➖ | Refusal message if content was refused | | -| `role` | [components.ChatAssistantMessageRole](../components/chatassistantmessagerole.mdx) | ✅ | N/A | | -| `tool_calls` | List[[components.ChatToolCall](../components/chattoolcall.mdx)] | ➖ | Tool calls made by the assistant | | \ No newline at end of file +| `audio` | [Optional[components.ChatAudioOutput]](../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[components.ChatAssistantMessageContent]](../components/chatassistantmessagecontent.mdx) | :heavy_minus_sign: | Assistant message content | | +| `images` | List[[components.ChatAssistantImages](../components/chatassistantimages.mdx)] | :heavy_minus_sign: | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | +| `model` | *Optional[str]* | :heavy_minus_sign: | Model that generated this assistant message | openai/gpt-4o | +| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the assistant | | +| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning output | | +| `reasoning_details` | List[[components.ReasoningDetailUnion](../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[str]* | :heavy_minus_sign: | Refusal message if content was refused | | +| `role` | [components.ChatAssistantMessageRole](../components/chatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | +| `tool_calls` | List[[components.ChatToolCall](../components/chattoolcall.mdx)] | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file diff --git a/docs/components/chataudiooutput.mdx b/docs/components/chataudiooutput.mdx index a1767a9c2..54812b591 100644 --- a/docs/components/chataudiooutput.mdx +++ b/docs/components/chataudiooutput.mdx @@ -9,7 +9,7 @@ Audio output data or reference | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `data` | *Optional[str]* | ➖ | Base64 encoded audio data | -| `expires_at` | *Optional[int]* | ➖ | Audio expiration timestamp | -| `id` | *Optional[str]* | ➖ | Audio output identifier | -| `transcript` | *Optional[str]* | ➖ | Audio transcript | \ No newline at end of file +| `data` | *Optional[str]* | :heavy_minus_sign: | Base64 encoded audio data | +| `expires_at` | *Optional[int]* | :heavy_minus_sign: | Audio expiration timestamp | +| `id` | *Optional[str]* | :heavy_minus_sign: | Audio output identifier | +| `transcript` | *Optional[str]* | :heavy_minus_sign: | Audio transcript | \ No newline at end of file diff --git a/docs/components/chatchoice.mdx b/docs/components/chatchoice.mdx index e40691404..614393130 100644 --- a/docs/components/chatchoice.mdx +++ b/docs/components/chatchoice.mdx @@ -9,7 +9,7 @@ Chat completion choice | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.mdx) | ✅ | N/A | stop | -| `index` | *int* | ✅ | Choice index | 0 | -| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../components/chattokenlogprobs.mdx) | ➖ | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | -| `message` | [components.ChatAssistantMessage](../components/chatassistantmessage.mdx) | ✅ | Assistant message for requests and responses | \{
"content": "What is the capital of France?",
"role": "user"
} | \ No newline at end of file +| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | +| `index` | *int* | :heavy_check_mark: | Choice index | 0 | +| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../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](../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/components/chatcontentaudio.mdx b/docs/components/chatcontentaudio.mdx index 11f0829a5..4fded9376 100644 --- a/docs/components/chatcontentaudio.mdx +++ b/docs/components/chatcontentaudio.mdx @@ -9,5 +9,5 @@ Audio input content part. Supported audio formats vary by provider. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `input_audio` | [components.ChatContentAudioInputAudio](../components/chatcontentaudioinputaudio.mdx) | ✅ | N/A | -| `type` | [components.ChatContentAudioType](../components/chatcontentaudiotype.mdx) | ✅ | N/A | \ No newline at end of file +| `input_audio` | [components.ChatContentAudioInputAudio](../components/chatcontentaudioinputaudio.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.ChatContentAudioType](../components/chatcontentaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chatcontentaudioinputaudio.mdx b/docs/components/chatcontentaudioinputaudio.mdx index 334c09222..06fd6a6c7 100644 --- a/docs/components/chatcontentaudioinputaudio.mdx +++ b/docs/components/chatcontentaudioinputaudio.mdx @@ -6,5 +6,5 @@ title: "ChatContentAudioInputAudio" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `data` | *str* | ✅ | Base64 encoded audio data | -| `format_` | *str* | ✅ | 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` | *str* | :heavy_check_mark: | Base64 encoded audio data | +| `format_` | *str* | :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/components/chatcontentcachecontrol.mdx b/docs/components/chatcontentcachecontrol.mdx index 5ea044a53..6f1d2f8e0 100644 --- a/docs/components/chatcontentcachecontrol.mdx +++ b/docs/components/chatcontentcachecontrol.mdx @@ -9,5 +9,5 @@ Anthropic-style cache breakpoint for the content part. Interchangeable with the | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | -| `type` | [components.ChatContentCacheControlType](../components/chatcontentcachecontroltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | +| `type` | [components.ChatContentCacheControlType](../components/chatcontentcachecontroltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/chatcontentfile.mdx b/docs/components/chatcontentfile.mdx index bb3770602..6be5dcf78 100644 --- a/docs/components/chatcontentfile.mdx +++ b/docs/components/chatcontentfile.mdx @@ -9,5 +9,5 @@ File content part for document processing | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `file` | [components.ChatContentFileFile](../components/chatcontentfilefile.mdx) | ✅ | N/A | -| `type` | [components.ChatContentFileType](../components/chatcontentfiletype.mdx) | ✅ | N/A | \ No newline at end of file +| `file` | [components.ChatContentFileFile](../components/chatcontentfilefile.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.ChatContentFileType](../components/chatcontentfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chatcontentfilefile.mdx b/docs/components/chatcontentfilefile.mdx index cd1e9fac3..8db78d18e 100644 --- a/docs/components/chatcontentfilefile.mdx +++ b/docs/components/chatcontentfilefile.mdx @@ -6,6 +6,6 @@ title: "ChatContentFileFile" | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `file_data` | *Optional[str]* | ➖ | File content as base64 data URL or URL | -| `file_id` | *Optional[str]* | ➖ | File ID for previously uploaded files | -| `filename` | *Optional[str]* | ➖ | Original filename | \ No newline at end of file +| `file_data` | *Optional[str]* | :heavy_minus_sign: | File content as base64 data URL or URL | +| `file_id` | *Optional[str]* | :heavy_minus_sign: | File ID for previously uploaded files | +| `filename` | *Optional[str]* | :heavy_minus_sign: | Original filename | \ No newline at end of file diff --git a/docs/components/chatcontentimage.mdx b/docs/components/chatcontentimage.mdx index 1d3fe4002..1dc215991 100644 --- a/docs/components/chatcontentimage.mdx +++ b/docs/components/chatcontentimage.mdx @@ -9,5 +9,5 @@ Image content part for vision models | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `image_url` | [components.ChatContentImageImageURL](../components/chatcontentimageimageurl.mdx) | ✅ | N/A | -| `type` | [components.ChatContentImageType](../components/chatcontentimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `image_url` | [components.ChatContentImageImageURL](../components/chatcontentimageimageurl.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.ChatContentImageType](../components/chatcontentimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chatcontentimageimageurl.mdx b/docs/components/chatcontentimageimageurl.mdx index 3a95d06de..814136649 100644 --- a/docs/components/chatcontentimageimageurl.mdx +++ b/docs/components/chatcontentimageimageurl.mdx @@ -6,5 +6,5 @@ title: "ChatContentImageImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `detail` | [Optional[components.ChatContentImageDetail]](../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` | *str* | ✅ | URL of the image (data: URLs supported) | \ No newline at end of file +| `detail` | [Optional[components.ChatContentImageDetail]](../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` | *str* | :heavy_check_mark: | URL of the image (data: URLs supported) | \ No newline at end of file diff --git a/docs/components/chatcontenttext.mdx b/docs/components/chatcontenttext.mdx index 9c1f10de5..b31006bd9 100644 --- a/docs/components/chatcontenttext.mdx +++ b/docs/components/chatcontenttext.mdx @@ -9,7 +9,7 @@ Text content part | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.ChatContentCacheControl]](../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"
} | -| `prompt_cache_breakpoint` | [OptionalNullable[components.PromptCacheBreakpoint]](../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` | *str* | ✅ | N/A | | -| `type` | [components.ChatContentTextType](../components/chatcontenttexttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.ChatContentCacheControl]](../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"
} | +| `prompt_cache_breakpoint` | [OptionalNullable[components.PromptCacheBreakpoint]](../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` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.ChatContentTextType](../components/chatcontenttexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/chatcontentvideo.mdx b/docs/components/chatcontentvideo.mdx index 2af782102..b8a1d5ee3 100644 --- a/docs/components/chatcontentvideo.mdx +++ b/docs/components/chatcontentvideo.mdx @@ -9,5 +9,5 @@ Video input content part | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [components.ChatContentVideoType](../components/chatcontentvideotype.mdx) | ✅ | N/A | | -| `video_url` | [components.ChatContentVideoInput](../components/chatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `type` | [components.ChatContentVideoType](../components/chatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | +| `video_url` | [components.ChatContentVideoInput](../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/components/chatcontentvideoinput.mdx b/docs/components/chatcontentvideoinput.mdx index 4bcc511df..3e3d6273f 100644 --- a/docs/components/chatcontentvideoinput.mdx +++ b/docs/components/chatcontentvideoinput.mdx @@ -9,5 +9,5 @@ Video input object | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `processing` | [Optional[components.ChatContentVideoInputProcessing]](../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` | *str* | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file +| `processing` | [Optional[components.ChatContentVideoInputProcessing]](../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` | *str* | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/components/chatdebugoptions.mdx b/docs/components/chatdebugoptions.mdx index 1d8c85bac..eee9489fd 100644 --- a/docs/components/chatdebugoptions.mdx +++ b/docs/components/chatdebugoptions.mdx @@ -9,4 +9,4 @@ Debug options for inspecting request transformations (streaming only) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `echo_upstream_body` | *Optional[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 +| `echo_upstream_body` | *Optional[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/components/chatdevelopermessage.mdx b/docs/components/chatdevelopermessage.mdx index 9dff56a52..3db8a03b3 100644 --- a/docs/components/chatdevelopermessage.mdx +++ b/docs/components/chatdevelopermessage.mdx @@ -9,7 +9,7 @@ Developer message | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration_update` | [OptionalNullable[components.ChatDeveloperMessageConfigurationUpdate]](../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](../components/chatdevelopermessagecontent.mdx) | ✅ | Developer message content | This is a message from the developer. | -| `name` | *Optional[str]* | ➖ | Optional name for the developer message | Developer | -| `role` | [components.ChatDeveloperMessageRole](../components/chatdevelopermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `configuration_update` | [OptionalNullable[components.ChatDeveloperMessageConfigurationUpdate]](../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](../components/chatdevelopermessagecontent.mdx) | :heavy_check_mark: | Developer message content | This is a message from the developer. | +| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the developer message | Developer | +| `role` | [components.ChatDeveloperMessageRole](../components/chatdevelopermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/chatdevelopermessageconfigurationupdate.mdx b/docs/components/chatdevelopermessageconfigurationupdate.mdx index 0681a6eac..f4dfd91b7 100644 --- a/docs/components/chatdevelopermessageconfigurationupdate.mdx +++ b/docs/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](../components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file +| `reasoning` | [components.ConfigurationUpdateReasoning](../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/components/chatdynamicservertool.mdx b/docs/components/chatdynamicservertool.mdx index a8a1e9a98..052db3b05 100644 --- a/docs/components/chatdynamicservertool.mdx +++ b/docs/components/chatdynamicservertool.mdx @@ -9,5 +9,5 @@ Generic OpenRouter server-tool envelope. `type` names a registered server tool ( | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `parameters` | Dict[str, *Any*] | ➖ | N/A | -| `type` | *str* | ✅ | N/A | \ No newline at end of file +| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `type` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chatformatgrammarconfig.mdx b/docs/components/chatformatgrammarconfig.mdx index 35db774b9..8595b8642 100644 --- a/docs/components/chatformatgrammarconfig.mdx +++ b/docs/components/chatformatgrammarconfig.mdx @@ -9,5 +9,5 @@ Custom grammar response format | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `grammar` | *str* | ✅ | Custom grammar for text generation | root ::= "yes" \| "no" | -| `type` | [components.ChatFormatGrammarConfigType](../components/chatformatgrammarconfigtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `grammar` | *str* | :heavy_check_mark: | Custom grammar for text generation | root ::= "yes" \| "no" | +| `type` | [components.ChatFormatGrammarConfigType](../components/chatformatgrammarconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/chatformatjsonobjectconfig.mdx b/docs/components/chatformatjsonobjectconfig.mdx index f7051d078..5dae96c73 100644 --- a/docs/components/chatformatjsonobjectconfig.mdx +++ b/docs/components/chatformatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | [components.ChatFormatJSONObjectConfigType](../components/chatformatjsonobjectconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.ChatFormatJSONObjectConfigType](../components/chatformatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chatformatjsonschemaconfig.mdx b/docs/components/chatformatjsonschemaconfig.mdx index 33f6fc167..565e33485 100644 --- a/docs/components/chatformatjsonschemaconfig.mdx +++ b/docs/components/chatformatjsonschemaconfig.mdx @@ -9,5 +9,5 @@ JSON Schema response format for structured outputs | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `json_schema` | [components.ChatJSONSchemaConfig](../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](../components/chatformatjsonschemaconfigtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `json_schema` | [components.ChatJSONSchemaConfig](../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](../components/chatformatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/chatformatpythonconfig.mdx b/docs/components/chatformatpythonconfig.mdx index b8d26c41c..cd0ab7ba1 100644 --- a/docs/components/chatformatpythonconfig.mdx +++ b/docs/components/chatformatpythonconfig.mdx @@ -9,4 +9,4 @@ Python code response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.ChatFormatPythonConfigType](../components/chatformatpythonconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.ChatFormatPythonConfigType](../components/chatformatpythonconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chatformattextconfig.mdx b/docs/components/chatformattextconfig.mdx index 188e66488..a539cad56 100644 --- a/docs/components/chatformattextconfig.mdx +++ b/docs/components/chatformattextconfig.mdx @@ -9,4 +9,4 @@ Default text response format | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.ChatFormatTextConfigType](../components/chatformattextconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.ChatFormatTextConfigType](../components/chatformattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chatfunctiontoolfunction.mdx b/docs/components/chatfunctiontoolfunction.mdx index bc7e937dd..0d3267343 100644 --- a/docs/components/chatfunctiontoolfunction.mdx +++ b/docs/components/chatfunctiontoolfunction.mdx @@ -6,7 +6,7 @@ title: "ChatFunctionToolFunction" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.ChatContentCacheControl]](../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"
} | -| `defer_loading` | *Optional[bool]* | ➖ | N/A | | -| `function` | [components.ChatFunctionToolFunctionFunction](../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](../components/chatfunctiontooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.ChatContentCacheControl]](../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"
} | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `function` | [components.ChatFunctionToolFunctionFunction](../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](../components/chatfunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/chatfunctiontoolfunctionfunction.mdx b/docs/components/chatfunctiontoolfunctionfunction.mdx index adecc6e87..b94555ae2 100644 --- a/docs/components/chatfunctiontoolfunctionfunction.mdx +++ b/docs/components/chatfunctiontoolfunctionfunction.mdx @@ -9,8 +9,8 @@ Function definition for tool calling | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `defer_loading` | *Optional[bool]* | ➖ | N/A | | -| `description` | *Optional[str]* | ➖ | Function description for the model | Get the current weather for a location | -| `name` | *str* | ✅ | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | -| `parameters` | Dict[str, *Any*] | ➖ | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | -| `strict` | *OptionalNullable[bool]* | ➖ | Enable strict schema adherence | false | \ No newline at end of file +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `description` | *Optional[str]* | :heavy_minus_sign: | Function description for the model | Get the current weather for a location | +| `name` | *str* | :heavy_check_mark: | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | +| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | +| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/components/chatjsonschemaconfig.mdx b/docs/components/chatjsonschemaconfig.mdx index 6cdf9d887..08887f520 100644 --- a/docs/components/chatjsonschemaconfig.mdx +++ b/docs/components/chatjsonschemaconfig.mdx @@ -9,7 +9,7 @@ JSON Schema configuration object | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `description` | *Optional[str]* | ➖ | Schema description for the model | A mathematical response | -| `name` | *str* | ✅ | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | -| `schema_` | Dict[str, *Any*] | ➖ | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | -| `strict` | *OptionalNullable[bool]* | ➖ | Enable strict schema adherence | false | \ No newline at end of file +| `description` | *Optional[str]* | :heavy_minus_sign: | Schema description for the model | A mathematical response | +| `name` | *str* | :heavy_check_mark: | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | +| `schema_` | Dict[str, *Any*] | :heavy_minus_sign: | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | +| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/components/chatnamedtoolchoice.mdx b/docs/components/chatnamedtoolchoice.mdx index a806b92c2..1c98093bf 100644 --- a/docs/components/chatnamedtoolchoice.mdx +++ b/docs/components/chatnamedtoolchoice.mdx @@ -9,5 +9,5 @@ Named tool choice for specific function | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `function` | [components.ChatNamedToolChoiceFunction](../components/chatnamedtoolchoicefunction.mdx) | ✅ | N/A | -| `type` | [components.ChatNamedToolChoiceType](../components/chatnamedtoolchoicetype.mdx) | ✅ | N/A | \ No newline at end of file +| `function` | [components.ChatNamedToolChoiceFunction](../components/chatnamedtoolchoicefunction.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.ChatNamedToolChoiceType](../components/chatnamedtoolchoicetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chatnamedtoolchoicefunction.mdx b/docs/components/chatnamedtoolchoicefunction.mdx index 4f83f319d..1824174f9 100644 --- a/docs/components/chatnamedtoolchoicefunction.mdx +++ b/docs/components/chatnamedtoolchoicefunction.mdx @@ -6,4 +6,4 @@ title: "ChatNamedToolChoiceFunction" | Field | Type | Required | Description | Example | | --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *str* | ✅ | Function name to call | get_weather | \ No newline at end of file +| `name` | *str* | :heavy_check_mark: | Function name to call | get_weather | \ No newline at end of file diff --git a/docs/components/chatrequest.mdx b/docs/components/chatrequest.mdx index b6c5a42b8..229ea863b 100644 --- a/docs/components/chatrequest.mdx +++ b/docs/components/chatrequest.mdx @@ -9,45 +9,45 @@ Chat completion request parameters | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.ChatDebugOptions]](../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | ➖ | Frequency penalty (-2.0 to 2.0) | 0 | -| `image_config` | Dict[str, [components.ImageConfig](../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"
} | -| `logit_bias` | Dict[str, *float*] | ➖ | Token logit bias adjustments | \{
"50256": -100
} | -| `logprobs` | *OptionalNullable[bool]* | ➖ | Return log probabilities | false | -| `max_completion_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens in completion | 100 | -| `max_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `messages` | List[[components.ChatMessages](../components/chatmessages.mdx)] | ✅ | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | -| `metadata` | Dict[str, *str*] | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | -| `min_p` | *OptionalNullable[float]* | ➖ | 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` | List[[components.Modality](../components/modality.mdx)] | ➖ | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *Optional[str]* | ➖ | Model to use for completion | openai/gpt-4 | -| `models` | List[*str*] | ➖ | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../components/chatrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | -| `prediction` | [OptionalNullable[components.Prediction]](../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"
} | -| `presence_penalty` | *OptionalNullable[float]* | ➖ | Presence penalty (-2.0 to 2.0) | 0 | -| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [Optional[components.ChatRequestReasoning]](../components/chatrequestreasoning.mdx) | ➖ | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../components/chatrequestreasoningeffort.mdx) | ➖ | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | -| `repetition_penalty` | *OptionalNullable[float]* | ➖ | 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 | -| `response_format` | [Optional[components.ResponseFormat]](../components/responseformat.mdx) | ➖ | Response format configuration | \{
"type": "json_object"
} | -| `seed` | *OptionalNullable[int]* | ➖ | Random seed for deterministic outputs | 42 | -| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../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 | -| `session_id` | *Optional[str]* | ➖ | 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[components.Stop]](../components/stop.mdx) | ➖ | Stop sequences (up to 4) | [
"\n"
] | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[bool]* | ➖ | Enable streaming response | false | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.mdx) | ➖ | Streaming configuration options | \{
"include_usage": true
} | -| `temperature` | *OptionalNullable[float]* | ➖ | Sampling temperature (0-2) | 0.7 | -| `tool_choice` | [Optional[components.ChatToolChoice]](../components/chattoolchoice.mdx) | ➖ | Tool choice configuration | auto | -| `tools` | List[[components.ChatFunctionTool](../components/chatfunctiontool.mdx)] | ➖ | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | -| `top_a` | *OptionalNullable[float]* | ➖ | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | -| `top_k` | *OptionalNullable[int]* | ➖ | 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 | -| `top_logprobs` | *OptionalNullable[int]* | ➖ | Number of top log probabilities to return (0-20) | 5 | -| `top_p` | *OptionalNullable[float]* | ➖ | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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 +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.ChatDebugOptions]](../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | +| `image_config` | Dict[str, [components.ImageConfig](../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"
} | +| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | +| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | +| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | +| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | +| `messages` | List[[components.ChatMessages](../components/chatmessages.mdx)] | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `metadata` | Dict[str, *str*] | :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"
} | +| `min_p` | *OptionalNullable[float]* | :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` | List[[components.Modality](../components/modality.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | +| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | +| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../components/chatrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `prediction` | [OptionalNullable[components.Prediction]](../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"
} | +| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | +| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [Optional[components.ChatRequestReasoning]](../components/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../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 | +| `repetition_penalty` | *OptionalNullable[float]* | :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 | +| `response_format` | [Optional[components.ResponseFormat]](../components/responseformat.mdx) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | +| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | +| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../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 | +| `session_id` | *Optional[str]* | :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[components.Stop]](../components/stop.mdx) | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | +| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.mdx) | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | +| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | +| `tool_choice` | [Optional[components.ChatToolChoice]](../components/chattoolchoice.mdx) | :heavy_minus_sign: | Tool choice configuration | auto | +| `tools` | List[[components.ChatFunctionTool](../components/chatfunctiontool.mdx)] | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `top_a` | *OptionalNullable[float]* | :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 | +| `top_k` | *OptionalNullable[int]* | :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 | +| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | +| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | +| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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/components/chatrequestreasoning.mdx b/docs/components/chatrequestreasoning.mdx index 1c04df67a..d9a271d74 100644 --- a/docs/components/chatrequestreasoning.mdx +++ b/docs/components/chatrequestreasoning.mdx @@ -9,5 +9,5 @@ Configuration options for reasoning models | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.ChatRequestEffort]](../components/chatrequesteffort.mdx) | ➖ | Constrains effort on reasoning for reasoning models | medium | -| `summary` | [OptionalNullable[components.ChatReasoningSummaryVerbosityEnum]](../components/chatreasoningsummaryverbosityenum.mdx) | ➖ | N/A | concise | \ No newline at end of file +| `effort` | [OptionalNullable[components.ChatRequestEffort]](../components/chatrequesteffort.mdx) | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | +| `summary` | [OptionalNullable[components.ChatReasoningSummaryVerbosityEnum]](../components/chatreasoningsummaryverbosityenum.mdx) | :heavy_minus_sign: | N/A | concise | \ No newline at end of file diff --git a/docs/components/chatresult.mdx b/docs/components/chatresult.mdx index 79c894f26..3f20da648 100644 --- a/docs/components/chatresult.mdx +++ b/docs/components/chatresult.mdx @@ -9,12 +9,12 @@ Chat completion response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | List[[components.ChatChoice](../components/chatchoice.mdx)] | ✅ | List of completion choices | | -| `created` | *int* | ✅ | Unix timestamp of creation | 1677652288 | -| `id` | *str* | ✅ | Unique completion identifier | chatcmpl-123 | -| `model` | *str* | ✅ | Model used for completion | openai/gpt-4 | -| `object` | [components.ChatResultObject](../components/chatresultobject.mdx) | ✅ | N/A | | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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"
} | -| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | default | -| `system_fingerprint` | *Nullable[str]* | ✅ | System fingerprint | fp_44709d6fcb | -| `usage` | [Optional[components.ChatUsage]](../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` | List[[components.ChatChoice](../components/chatchoice.mdx)] | :heavy_check_mark: | List of completion choices | | +| `created` | *int* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | +| `id` | *str* | :heavy_check_mark: | Unique completion identifier | chatcmpl-123 | +| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | +| `object` | [components.ChatResultObject](../components/chatresultobject.mdx) | :heavy_check_mark: | N/A | | +| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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"
} | +| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | +| `system_fingerprint` | *Nullable[str]* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb | +| `usage` | [Optional[components.ChatUsage]](../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/components/chatsearchmodelsservertool.mdx b/docs/components/chatsearchmodelsservertool.mdx index 4acc95750..18b2f4e1a 100644 --- a/docs/components/chatsearchmodelsservertool.mdx +++ b/docs/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` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [components.ChatSearchModelsServerToolType](../components/chatsearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [components.ChatSearchModelsServerToolType](../components/chatsearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/chatservertoolchoice.mdx b/docs/components/chatservertoolchoice.mdx index 444efbbfa..9eac8152d 100644 --- a/docs/components/chatservertoolchoice.mdx +++ b/docs/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` | *str* | ✅ | 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` | *str* | :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/components/chatstreamchoice.mdx b/docs/components/chatstreamchoice.mdx index 1454ec663..d6bd70fb2 100644 --- a/docs/components/chatstreamchoice.mdx +++ b/docs/components/chatstreamchoice.mdx @@ -9,7 +9,7 @@ Streaming completion choice chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `delta` | [components.ChatStreamDelta](../components/chatstreamdelta.mdx) | ✅ | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | -| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.mdx) | ✅ | N/A | stop | -| `index` | *int* | ✅ | Choice index | 0 | -| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../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](../components/chatstreamdelta.mdx) | :heavy_check_mark: | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | +| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | +| `index` | *int* | :heavy_check_mark: | Choice index | 0 | +| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../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/components/chatstreamchunk.mdx b/docs/components/chatstreamchunk.mdx index b80260437..ccddb5a2b 100644 --- a/docs/components/chatstreamchunk.mdx +++ b/docs/components/chatstreamchunk.mdx @@ -9,13 +9,13 @@ Streaming chat completion chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | List[[components.ChatStreamChoice](../components/chatstreamchoice.mdx)] | ✅ | List of streaming chunk choices | | -| `created` | *int* | ✅ | Unix timestamp of creation | 1677652288 | -| `error` | [Optional[components.ChatStreamChunkError]](../components/chatstreamchunkerror.mdx) | ➖ | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | -| `id` | *str* | ✅ | Unique chunk identifier | chatcmpl-123 | -| `model` | *str* | ✅ | Model used for completion | openai/gpt-4 | -| `object` | [components.ChatStreamChunkObject](../components/chatstreamchunkobject.mdx) | ✅ | N/A | | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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"
} | -| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | default | -| `system_fingerprint` | *Optional[str]* | ➖ | System fingerprint | fp_44709d6fcb | -| `usage` | [Optional[components.ChatUsage]](../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` | List[[components.ChatStreamChoice](../components/chatstreamchoice.mdx)] | :heavy_check_mark: | List of streaming chunk choices | | +| `created` | *int* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | +| `error` | [Optional[components.ChatStreamChunkError]](../components/chatstreamchunkerror.mdx) | :heavy_minus_sign: | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | +| `id` | *str* | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 | +| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | +| `object` | [components.ChatStreamChunkObject](../components/chatstreamchunkobject.mdx) | :heavy_check_mark: | N/A | | +| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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"
} | +| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | +| `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | +| `usage` | [Optional[components.ChatUsage]](../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/components/chatstreamchunkerror.mdx b/docs/components/chatstreamchunkerror.mdx index b505cee0f..e04b55b06 100644 --- a/docs/components/chatstreamchunkerror.mdx +++ b/docs/components/chatstreamchunkerror.mdx @@ -9,6 +9,6 @@ Error information | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `code` | *int* | ✅ | Error code | 429 | -| `message` | *str* | ✅ | Error message | Rate limit exceeded | -| `metadata` | [Optional[components.ChatStreamChunkMetadata]](../components/chatstreamchunkmetadata.mdx) | ➖ | Structured error metadata | | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | Error code | 429 | +| `message` | *str* | :heavy_check_mark: | Error message | Rate limit exceeded | +| `metadata` | [Optional[components.ChatStreamChunkMetadata]](../components/chatstreamchunkmetadata.mdx) | :heavy_minus_sign: | Structured error metadata | | \ No newline at end of file diff --git a/docs/components/chatstreamchunkmetadata.mdx b/docs/components/chatstreamchunkmetadata.mdx index 8a94144ad..ce80e38c1 100644 --- a/docs/components/chatstreamchunkmetadata.mdx +++ b/docs/components/chatstreamchunkmetadata.mdx @@ -9,5 +9,5 @@ Structured error metadata | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `error_type` | [components.APIErrorType](../components/apierrortype.mdx) | ✅ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `provider_code` | *Optional[str]* | ➖ | Upstream provider-specific error code, when available | | \ No newline at end of file +| `error_type` | [components.APIErrorType](../components/apierrortype.mdx) | :heavy_check_mark: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `provider_code` | *Optional[str]* | :heavy_minus_sign: | Upstream provider-specific error code, when available | | \ No newline at end of file diff --git a/docs/components/chatstreamdelta.mdx b/docs/components/chatstreamdelta.mdx index 96d2d54bf..3ac2bd92b 100644 --- a/docs/components/chatstreamdelta.mdx +++ b/docs/components/chatstreamdelta.mdx @@ -9,10 +9,10 @@ Delta changes in streaming response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [Optional[components.ChatAudioOutput]](../components/chataudiooutput.mdx) | ➖ | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | -| `content` | *OptionalNullable[str]* | ➖ | Message content delta | Hello | -| `reasoning` | *OptionalNullable[str]* | ➖ | Reasoning content delta | I need to | -| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.mdx)] | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | -| `refusal` | *OptionalNullable[str]* | ➖ | Refusal message delta | null | -| `role` | [Optional[components.ChatStreamDeltaRole]](../components/chatstreamdeltarole.mdx) | ➖ | The role of the message author | assistant | -| `tool_calls` | List[[components.ChatStreamToolCall](../components/chatstreamtoolcall.mdx)] | ➖ | Tool calls delta | | \ No newline at end of file +| `audio` | [Optional[components.ChatAudioOutput]](../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[str]* | :heavy_minus_sign: | Message content delta | Hello | +| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to | +| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.mdx)] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | +| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | null | +| `role` | [Optional[components.ChatStreamDeltaRole]](../components/chatstreamdeltarole.mdx) | :heavy_minus_sign: | The role of the message author | assistant | +| `tool_calls` | List[[components.ChatStreamToolCall](../components/chatstreamtoolcall.mdx)] | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file diff --git a/docs/components/chatstreamingresponse.mdx b/docs/components/chatstreamingresponse.mdx index cb5cff0c7..bd7543c94 100644 --- a/docs/components/chatstreamingresponse.mdx +++ b/docs/components/chatstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ChatStreamingResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ChatStreamChunk](../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](../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/components/chatstreamoptions.mdx b/docs/components/chatstreamoptions.mdx index cd099d499..430faf2a0 100644 --- a/docs/components/chatstreamoptions.mdx +++ b/docs/components/chatstreamoptions.mdx @@ -9,4 +9,4 @@ Streaming configuration options | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ~~`include_usage`~~ | *Optional[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 +| ~~`include_usage`~~ | *Optional[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/components/chatstreamtoolcall.mdx b/docs/components/chatstreamtoolcall.mdx index 5a4327a1a..beba823a6 100644 --- a/docs/components/chatstreamtoolcall.mdx +++ b/docs/components/chatstreamtoolcall.mdx @@ -9,7 +9,7 @@ Tool call delta for streaming responses | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `function` | [Optional[components.ChatStreamToolCallFunction]](../components/chatstreamtoolcallfunction.mdx) | ➖ | Function call details | | -| `id` | *Optional[str]* | ➖ | Tool call identifier | call_abc123 | -| `index` | *int* | ✅ | Tool call index in the array | 0 | -| `type` | [Optional[components.ChatStreamToolCallType]](../components/chatstreamtoolcalltype.mdx) | ➖ | Tool call type | function | \ No newline at end of file +| `function` | [Optional[components.ChatStreamToolCallFunction]](../components/chatstreamtoolcallfunction.mdx) | :heavy_minus_sign: | Function call details | | +| `id` | *Optional[str]* | :heavy_minus_sign: | Tool call identifier | call_abc123 | +| `index` | *int* | :heavy_check_mark: | Tool call index in the array | 0 | +| `type` | [Optional[components.ChatStreamToolCallType]](../components/chatstreamtoolcalltype.mdx) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file diff --git a/docs/components/chatstreamtoolcallfunction.mdx b/docs/components/chatstreamtoolcallfunction.mdx index 59f94e221..12a71db2d 100644 --- a/docs/components/chatstreamtoolcallfunction.mdx +++ b/docs/components/chatstreamtoolcallfunction.mdx @@ -9,5 +9,5 @@ Function call details | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *Optional[str]* | ➖ | Function arguments as JSON string | \{"location": "..."} | -| `name` | *Optional[str]* | ➖ | Function name | get_weather | \ No newline at end of file +| `arguments` | *Optional[str]* | :heavy_minus_sign: | Function arguments as JSON string | \{"location": "..."} | +| `name` | *Optional[str]* | :heavy_minus_sign: | Function name | get_weather | \ No newline at end of file diff --git a/docs/components/chatsystemmessage.mdx b/docs/components/chatsystemmessage.mdx index b29202ee8..d904f59d2 100644 --- a/docs/components/chatsystemmessage.mdx +++ b/docs/components/chatsystemmessage.mdx @@ -9,7 +9,7 @@ System message for setting behavior | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration_update` | [OptionalNullable[components.ChatSystemMessageConfigurationUpdate]](../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](../components/chatsystemmessagecontent.mdx) | ✅ | System message content | You are a helpful assistant. | -| `name` | *Optional[str]* | ➖ | Optional name for the system message | Assistant Config | -| `role` | [components.ChatSystemMessageRole](../components/chatsystemmessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `configuration_update` | [OptionalNullable[components.ChatSystemMessageConfigurationUpdate]](../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](../components/chatsystemmessagecontent.mdx) | :heavy_check_mark: | System message content | You are a helpful assistant. | +| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the system message | Assistant Config | +| `role` | [components.ChatSystemMessageRole](../components/chatsystemmessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/chatsystemmessageconfigurationupdate.mdx b/docs/components/chatsystemmessageconfigurationupdate.mdx index e9b57360b..31dd268a4 100644 --- a/docs/components/chatsystemmessageconfigurationupdate.mdx +++ b/docs/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](../components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file +| `reasoning` | [components.ConfigurationUpdateReasoning](../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/components/chattokenlogprob.mdx b/docs/components/chattokenlogprob.mdx index 2f18f3f90..f6b39af96 100644 --- a/docs/components/chattokenlogprob.mdx +++ b/docs/components/chattokenlogprob.mdx @@ -9,7 +9,7 @@ Token log probability information | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | ✅ | UTF-8 bytes of the token | -| `logprob` | *float* | ✅ | Log probability of the token | -| `token` | *str* | ✅ | The token | -| `top_logprobs` | List[[components.ChatTokenLogprobTopLogprob](../components/chattokenlogprobtoplogprob.mdx)] | ✅ | Top alternative tokens with probabilities | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_check_mark: | UTF-8 bytes of the token | +| `logprob` | *float* | :heavy_check_mark: | Log probability of the token | +| `token` | *str* | :heavy_check_mark: | The token | +| `top_logprobs` | List[[components.ChatTokenLogprobTopLogprob](../components/chattokenlogprobtoplogprob.mdx)] | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/docs/components/chattokenlogprobs.mdx b/docs/components/chattokenlogprobs.mdx index 20701c1da..068610e7a 100644 --- a/docs/components/chattokenlogprobs.mdx +++ b/docs/components/chattokenlogprobs.mdx @@ -9,5 +9,5 @@ Log probabilities for the completion | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `content` | List[[components.ChatTokenLogprob](../components/chattokenlogprob.mdx)] | ✅ | Log probabilities for content tokens | -| `refusal` | List[[components.ChatTokenLogprob](../components/chattokenlogprob.mdx)] | ➖ | Log probabilities for refusal tokens | \ No newline at end of file +| `content` | List[[components.ChatTokenLogprob](../components/chattokenlogprob.mdx)] | :heavy_check_mark: | Log probabilities for content tokens | +| `refusal` | List[[components.ChatTokenLogprob](../components/chattokenlogprob.mdx)] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/docs/components/chattokenlogprobtoplogprob.mdx b/docs/components/chattokenlogprobtoplogprob.mdx index b167ece21..89813675b 100644 --- a/docs/components/chattokenlogprobtoplogprob.mdx +++ b/docs/components/chattokenlogprobtoplogprob.mdx @@ -6,6 +6,6 @@ title: "ChatTokenLogprobTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | ✅ | N/A | -| `logprob` | *float* | ✅ | N/A | -| `token` | *str* | ✅ | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | +| `logprob` | *float* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chattoolcall.mdx b/docs/components/chattoolcall.mdx index 54f6698ac..09bffc9d9 100644 --- a/docs/components/chattoolcall.mdx +++ b/docs/components/chattoolcall.mdx @@ -9,6 +9,6 @@ Tool call made by the assistant | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `function` | [components.ChatToolCallFunction](../components/chattoolcallfunction.mdx) | ✅ | N/A | -| `id` | *str* | ✅ | Tool call identifier | -| `type` | [components.ChatToolCallType](../components/chattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file +| `function` | [components.ChatToolCallFunction](../components/chattoolcallfunction.mdx) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | Tool call identifier | +| `type` | [components.ChatToolCallType](../components/chattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/chattoolcallfunction.mdx b/docs/components/chattoolcallfunction.mdx index f60699894..bf3ffcadc 100644 --- a/docs/components/chattoolcallfunction.mdx +++ b/docs/components/chattoolcallfunction.mdx @@ -6,5 +6,5 @@ title: "ChatToolCallFunction" | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *str* | ✅ | Function arguments as JSON string | -| `name` | *str* | ✅ | Function name to call | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | Function arguments as JSON string | +| `name` | *str* | :heavy_check_mark: | Function name to call | \ No newline at end of file diff --git a/docs/components/chattoolmessage.mdx b/docs/components/chattoolmessage.mdx index 190aac46f..bd39bbff2 100644 --- a/docs/components/chattoolmessage.mdx +++ b/docs/components/chattoolmessage.mdx @@ -9,6 +9,6 @@ Tool response message | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `content` | [components.ChatToolMessageContent](../components/chattoolmessagecontent.mdx) | ✅ | Tool response content | The weather in San Francisco is 72°F and sunny. | -| `role` | [components.ChatToolMessageRole](../components/chattoolmessagerole.mdx) | ✅ | N/A | | -| `tool_call_id` | *str* | ✅ | ID of the assistant message tool call this message responds to | call_abc123 | \ No newline at end of file +| `content` | [components.ChatToolMessageContent](../components/chattoolmessagecontent.mdx) | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | +| `role` | [components.ChatToolMessageRole](../components/chattoolmessagerole.mdx) | :heavy_check_mark: | N/A | | +| `tool_call_id` | *str* | :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/components/chatusage.mdx b/docs/components/chatusage.mdx index 51d9a7d64..a32fff446 100644 --- a/docs/components/chatusage.mdx +++ b/docs/components/chatusage.mdx @@ -9,12 +9,12 @@ Token usage statistics | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `completion_tokens` | *int* | ✅ | Number of tokens in the completion | | -| `completion_tokens_details` | [OptionalNullable[components.ChatUsageCompletionTokensDetails]](../components/chatusagecompletiontokensdetails.mdx) | ➖ | Detailed completion token usage | | -| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `prompt_tokens` | *int* | ✅ | Number of tokens in the prompt | | -| `prompt_tokens_details` | [OptionalNullable[components.ChatUsagePromptTokensDetails]](../components/chatusageprompttokensdetails.mdx) | ➖ | Detailed prompt token usage | | -| `server_tool_use_details` | [OptionalNullable[components.ServerToolUseDetails]](../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
} | -| `total_tokens` | *int* | ✅ | Total number of tokens | | \ No newline at end of file +| `completion_tokens` | *int* | :heavy_check_mark: | Number of tokens in the completion | | +| `completion_tokens_details` | [OptionalNullable[components.ChatUsageCompletionTokensDetails]](../components/chatusagecompletiontokensdetails.mdx) | :heavy_minus_sign: | Detailed completion token usage | | +| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | +| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `prompt_tokens` | *int* | :heavy_check_mark: | Number of tokens in the prompt | | +| `prompt_tokens_details` | [OptionalNullable[components.ChatUsagePromptTokensDetails]](../components/chatusageprompttokensdetails.mdx) | :heavy_minus_sign: | Detailed prompt token usage | | +| `server_tool_use_details` | [OptionalNullable[components.ServerToolUseDetails]](../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
} | +| `total_tokens` | *int* | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file diff --git a/docs/components/chatusagecompletiontokensdetails.mdx b/docs/components/chatusagecompletiontokensdetails.mdx index 579a30a6d..6ac1392b3 100644 --- a/docs/components/chatusagecompletiontokensdetails.mdx +++ b/docs/components/chatusagecompletiontokensdetails.mdx @@ -9,7 +9,7 @@ Detailed completion token usage | Field | Type | Required | Description | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `accepted_prediction_tokens` | *OptionalNullable[int]* | ➖ | Accepted prediction tokens | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for audio output | -| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for reasoning | -| `rejected_prediction_tokens` | *OptionalNullable[int]* | ➖ | Rejected prediction tokens | \ No newline at end of file +| `accepted_prediction_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Accepted prediction tokens | +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for audio output | +| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for reasoning | +| `rejected_prediction_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Rejected prediction tokens | \ No newline at end of file diff --git a/docs/components/chatusageprompttokensdetails.mdx b/docs/components/chatusageprompttokensdetails.mdx index f53ccc962..0f5dac4b5 100644 --- a/docs/components/chatusageprompttokensdetails.mdx +++ b/docs/components/chatusageprompttokensdetails.mdx @@ -9,7 +9,7 @@ Detailed prompt token usage | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *Optional[int]* | ➖ | Audio input tokens | -| `cache_write_tokens` | *Optional[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *Optional[int]* | ➖ | Cached prompt tokens | -| `video_tokens` | *Optional[int]* | ➖ | Video input tokens | \ No newline at end of file +| `audio_tokens` | *Optional[int]* | :heavy_minus_sign: | Audio input tokens | +| `cache_write_tokens` | *Optional[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *Optional[int]* | :heavy_minus_sign: | Cached prompt tokens | +| `video_tokens` | *Optional[int]* | :heavy_minus_sign: | Video input tokens | \ No newline at end of file diff --git a/docs/components/chatusermessage.mdx b/docs/components/chatusermessage.mdx index 3ec478d05..3b6546aa3 100644 --- a/docs/components/chatusermessage.mdx +++ b/docs/components/chatusermessage.mdx @@ -9,6 +9,6 @@ User message | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `content` | [components.ChatUserMessageContent](../components/chatusermessagecontent.mdx) | ✅ | User message content | What is the capital of France? | -| `name` | *Optional[str]* | ➖ | Optional name for the user | User | -| `role` | [components.ChatUserMessageRole](../components/chatusermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `content` | [components.ChatUserMessageContent](../components/chatusermessagecontent.mdx) | :heavy_check_mark: | User message content | What is the capital of France? | +| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the user | User | +| `role` | [components.ChatUserMessageRole](../components/chatusermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/chatwebsearchshorthand.mdx b/docs/components/chatwebsearchshorthand.mdx index a6e1c059d..ae3a68743 100644 --- a/docs/components/chatwebsearchshorthand.mdx +++ b/docs/components/chatwebsearchshorthand.mdx @@ -9,16 +9,16 @@ Web search tool using OpenAI Responses API syntax. Automatically converted to op | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | ➖ | 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` | [Optional[components.WebSearchEngineEnum]](../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 | -| `excluded_domains` | List[*str*] | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `max_characters` | *Optional[int]* | ➖ | 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 | -| `max_results` | *Optional[int]* | ➖ | 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 | -| `max_total_results` | *Optional[int]* | ➖ | 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 | -| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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` | [Optional[components.WebSearchConfig]](../components/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `search_context_size` | [Optional[components.SearchQualityLevel]](../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](../components/chatwebsearchshorthandtype.mdx) | ✅ | N/A | | -| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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 +| `allowed_domains` | List[*str*] | :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` | [Optional[components.WebSearchEngineEnum]](../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 | +| `excluded_domains` | List[*str*] | :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. | | +| `max_characters` | *Optional[int]* | :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 | +| `max_results` | *Optional[int]* | :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 | +| `max_total_results` | *Optional[int]* | :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 | +| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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` | [Optional[components.WebSearchConfig]](../components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `search_context_size` | [Optional[components.SearchQualityLevel]](../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](../components/chatwebsearchshorthandtype.mdx) | :heavy_check_mark: | N/A | | +| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../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"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/choice.mdx b/docs/components/choice.mdx index db64a2a1a..09102913c 100644 --- a/docs/components/choice.mdx +++ b/docs/components/choice.mdx @@ -6,8 +6,8 @@ title: "Choice" | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `finish_reason` | [components.FinishReason](../components/finishreason.mdx) | ✅ | N/A | stop | -| `index` | *int* | ✅ | N/A | | -| `logprobs` | [Nullable[components.Logprobs]](../components/logprobs.mdx) | ✅ | N/A | | -| `message` | [components.Message](../components/message.mdx) | ✅ | N/A | | -| `native_finish_reason` | *Nullable[str]* | ✅ | N/A | | \ No newline at end of file +| `finish_reason` | [components.FinishReason](../components/finishreason.mdx) | :heavy_check_mark: | N/A | stop | +| `index` | *int* | :heavy_check_mark: | N/A | | +| `logprobs` | [Nullable[components.Logprobs]](../components/logprobs.mdx) | :heavy_check_mark: | N/A | | +| `message` | [components.Message](../components/message.mdx) | :heavy_check_mark: | N/A | | +| `native_finish_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/codeinterpretercallcodedeltaevent.mdx b/docs/components/codeinterpretercallcodedeltaevent.mdx index 78db21e41..70e78af03 100644 --- a/docs/components/codeinterpretercallcodedeltaevent.mdx +++ b/docs/components/codeinterpretercallcodedeltaevent.mdx @@ -9,8 +9,8 @@ Incremental chunk of code being streamed for a `code_interpreter_call`. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `delta` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.CodeInterpreterCallCodeDeltaEventType](../components/codeinterpretercallcodedeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.CodeInterpreterCallCodeDeltaEventType](../components/codeinterpretercallcodedeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpretercallcodedoneevent.mdx b/docs/components/codeinterpretercallcodedoneevent.mdx index 09a6ebca0..d7bc2ec6b 100644 --- a/docs/components/codeinterpretercallcodedoneevent.mdx +++ b/docs/components/codeinterpretercallcodedoneevent.mdx @@ -9,8 +9,8 @@ Emitted when code streaming completes for a `code_interpreter_call`. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `code` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.CodeInterpreterCallCodeDoneEventType](../components/codeinterpretercallcodedoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `code` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.CodeInterpreterCallCodeDoneEventType](../components/codeinterpretercallcodedoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpretercallcompletedevent.mdx b/docs/components/codeinterpretercallcompletedevent.mdx index 693b2b709..0589dc6b4 100644 --- a/docs/components/codeinterpretercallcompletedevent.mdx +++ b/docs/components/codeinterpretercallcompletedevent.mdx @@ -9,7 +9,7 @@ Code interpreter call completed | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.CodeInterpreterCallCompletedEventType](../components/codeinterpretercallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.CodeInterpreterCallCompletedEventType](../components/codeinterpretercallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpretercallinprogressevent.mdx b/docs/components/codeinterpretercallinprogressevent.mdx index 3edcaa3a1..0c1876df6 100644 --- a/docs/components/codeinterpretercallinprogressevent.mdx +++ b/docs/components/codeinterpretercallinprogressevent.mdx @@ -9,7 +9,7 @@ Code interpreter call in progress | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.CodeInterpreterCallInProgressEventType](../components/codeinterpretercallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.CodeInterpreterCallInProgressEventType](../components/codeinterpretercallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpretercallinterpretingevent.mdx b/docs/components/codeinterpretercallinterpretingevent.mdx index 9c4d17ab6..92fb7446f 100644 --- a/docs/components/codeinterpretercallinterpretingevent.mdx +++ b/docs/components/codeinterpretercallinterpretingevent.mdx @@ -9,7 +9,7 @@ Code interpreter is executing the code | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.CodeInterpreterCallInterpretingEventType](../components/codeinterpretercallinterpretingeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.CodeInterpreterCallInterpretingEventType](../components/codeinterpretercallinterpretingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpreterfileoutput.mdx b/docs/components/codeinterpreterfileoutput.mdx index e78a0b94f..623e61267 100644 --- a/docs/components/codeinterpreterfileoutput.mdx +++ b/docs/components/codeinterpreterfileoutput.mdx @@ -6,13 +6,13 @@ title: "CodeInterpreterFileOutput" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `download_url` | *Optional[str]* | ➖ | Provider-issued download URL for the generated file. Typically signed and time-limited (see `expires_at`); fetch promptly rather than persisting the URL. | -| `error_code` | *OptionalNullable[str]* | ➖ | Provider error code when generating or persisting the file failed; null or absent on success. | -| `expires_at` | *Optional[str]* | ➖ | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | -| `filename` | *Optional[str]* | ➖ | N/A | -| `id` | *Optional[str]* | ➖ | N/A | -| `media_type` | *Optional[str]* | ➖ | N/A | -| `sha256` | *Optional[str]* | ➖ | N/A | -| `size_bytes` | *Optional[int]* | ➖ | N/A | -| `status` | *Optional[str]* | ➖ | Provider-reported readiness of the generated file (e.g. `ready`). Values other than `ready` indicate the artifact may not be downloadable. | -| `type` | [components.CodeInterpreterFileOutputType](../components/codeinterpreterfileoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `download_url` | *Optional[str]* | :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. | +| `error_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Provider error code when generating or persisting the file failed; null or absent on success. | +| `expires_at` | *Optional[str]* | :heavy_minus_sign: | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | +| `filename` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `media_type` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `sha256` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `size_bytes` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `status` | *Optional[str]* | :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](../components/codeinterpreterfileoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpreterimageoutput.mdx b/docs/components/codeinterpreterimageoutput.mdx index f8487fc71..e259d6ef5 100644 --- a/docs/components/codeinterpreterimageoutput.mdx +++ b/docs/components/codeinterpreterimageoutput.mdx @@ -6,5 +6,5 @@ title: "CodeInterpreterImageOutput" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | [components.CodeInterpreterImageOutputType](../components/codeinterpreterimageoutputtype.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `type` | [components.CodeInterpreterImageOutputType](../components/codeinterpreterimageoutputtype.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpreterlogsoutput.mdx b/docs/components/codeinterpreterlogsoutput.mdx index 6e6cf93ae..9ac144a81 100644 --- a/docs/components/codeinterpreterlogsoutput.mdx +++ b/docs/components/codeinterpreterlogsoutput.mdx @@ -6,5 +6,5 @@ title: "CodeInterpreterLogsOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `logs` | *str* | ✅ | N/A | -| `type` | [components.CodeInterpreterLogsOutputType](../components/codeinterpreterlogsoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `logs` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.CodeInterpreterLogsOutputType](../components/codeinterpreterlogsoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpreterservertool.mdx b/docs/components/codeinterpreterservertool.mdx index a3ceace7d..952662124 100644 --- a/docs/components/codeinterpreterservertool.mdx +++ b/docs/components/codeinterpreterservertool.mdx @@ -9,5 +9,5 @@ Code interpreter tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `container` | [components.Container](../components/container.mdx) | ✅ | N/A | -| `type` | [components.TypeCodeInterpreter](../components/typecodeinterpreter.mdx) | ✅ | N/A | \ No newline at end of file +| `container` | [components.Container](../components/container.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.TypeCodeInterpreter](../components/typecodeinterpreter.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/codexlocalshelltool.mdx b/docs/components/codexlocalshelltool.mdx index 62e00b6ee..f5b8e9d3c 100644 --- a/docs/components/codexlocalshelltool.mdx +++ b/docs/components/codexlocalshelltool.mdx @@ -9,4 +9,4 @@ Local shell tool configuration | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `type` | [components.CodexLocalShellToolType](../components/codexlocalshelltooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.CodexLocalShellToolType](../components/codexlocalshelltooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/compactionitem.mdx b/docs/components/compactionitem.mdx index 04a99b493..313c76b10 100644 --- a/docs/components/compactionitem.mdx +++ b/docs/components/compactionitem.mdx @@ -9,7 +9,7 @@ A context compaction marker with encrypted summary | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `encrypted_content` | *str* | ✅ | N/A | | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `type` | [components.CompactionItemType](../components/compactionitemtype.mdx) | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file +| `encrypted_content` | *str* | :heavy_check_mark: | N/A | | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.CompactionItemType](../components/compactionitemtype.mdx) | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file diff --git a/docs/components/compoundfilter.mdx b/docs/components/compoundfilter.mdx index 809ceef34..31f3a0631 100644 --- a/docs/components/compoundfilter.mdx +++ b/docs/components/compoundfilter.mdx @@ -9,5 +9,5 @@ A compound filter that combines multiple comparison or compound filters | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `filters` | List[Dict[str, *Any*]] | ✅ | N/A | -| `type` | [components.CompoundFilterType](../components/compoundfiltertype.mdx) | ✅ | N/A | \ No newline at end of file +| `filters` | List[Dict[str, *Any*]] | :heavy_check_mark: | N/A | +| `type` | [components.CompoundFilterType](../components/compoundfiltertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/computeruseservertool.mdx b/docs/components/computeruseservertool.mdx index 87de2572a..3021debd9 100644 --- a/docs/components/computeruseservertool.mdx +++ b/docs/components/computeruseservertool.mdx @@ -9,7 +9,7 @@ Computer use preview tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `display_height` | *int* | ✅ | N/A | -| `display_width` | *int* | ✅ | N/A | -| `environment` | [components.Environment](../components/environment.mdx) | ✅ | N/A | -| `type` | [components.ComputerUseServerToolType](../components/computeruseservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `display_height` | *int* | :heavy_check_mark: | N/A | +| `display_width` | *int* | :heavy_check_mark: | N/A | +| `environment` | [components.Environment](../components/environment.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.ComputerUseServerToolType](../components/computeruseservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/configurationupdateitem.mdx b/docs/components/configurationupdateitem.mdx index 7a7e28631..fdba8d18c 100644 --- a/docs/components/configurationupdateitem.mdx +++ b/docs/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[str]* | ➖ | N/A | | -| `reasoning` | [components.ConfigurationUpdateReasoning](../components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | -| `type` | [components.ConfigurationUpdateItemType](../components/configurationupdateitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `reasoning` | [components.ConfigurationUpdateReasoning](../components/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | +| `type` | [components.ConfigurationUpdateItemType](../components/configurationupdateitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/configurationupdatereasoning.mdx b/docs/components/configurationupdatereasoning.mdx index c570d32fa..3b99a0e51 100644 --- a/docs/components/configurationupdatereasoning.mdx +++ b/docs/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](../components/configurationupdatereasoningeffort.mdx) | ✅ | Reasoning effort to apply from this point in the conversation onward | low | \ No newline at end of file +| `effort` | [components.ConfigurationUpdateReasoningEffort](../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/components/conflictresponseerrordata.mdx b/docs/components/conflictresponseerrordata.mdx index 9f26ef4d9..6216c3834 100644 --- a/docs/components/conflictresponseerrordata.mdx +++ b/docs/components/conflictresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ConflictResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/containerauto.mdx b/docs/components/containerauto.mdx index cde390a4f..00e55b66a 100644 --- a/docs/components/containerauto.mdx +++ b/docs/components/containerauto.mdx @@ -6,6 +6,6 @@ title: "ContainerAuto" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `file_ids` | List[*str*] | ➖ | N/A | -| `memory_limit` | [OptionalNullable[components.MemoryLimit]](../components/memorylimit.mdx) | ➖ | N/A | -| `type` | [components.ContainerType](../components/containertype.mdx) | ✅ | N/A | \ No newline at end of file +| `file_ids` | List[*str*] | :heavy_minus_sign: | N/A | +| `memory_limit` | [OptionalNullable[components.MemoryLimit]](../components/memorylimit.mdx) | :heavy_minus_sign: | N/A | +| `type` | [components.ContainerType](../components/containertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/containerautoenvironment.mdx b/docs/components/containerautoenvironment.mdx index fd04bc26e..b4e599c19 100644 --- a/docs/components/containerautoenvironment.mdx +++ b/docs/components/containerautoenvironment.mdx @@ -9,6 +9,6 @@ An OpenRouter-managed, auto-provisioned ephemeral container. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file_ids` | List[*str*] | ➖ | 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"
] | -| `network_policy` | [Optional[components.ContainerNetworkPolicy]](../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](../components/containerautoenvironmenttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `file_ids` | List[*str*] | :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"
] | +| `network_policy` | [Optional[components.ContainerNetworkPolicy]](../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](../components/containerautoenvironmenttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/containerfile.mdx b/docs/components/containerfile.mdx index 6d8f3b4c5..63e4189bb 100644 --- a/docs/components/containerfile.mdx +++ b/docs/components/containerfile.mdx @@ -6,10 +6,10 @@ title: "ContainerFile" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `bytes_` | *int* | ✅ | File size in bytes. | 123 | -| `container_id` | *str* | ✅ | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | -| `created_at` | *int* | ✅ | Unix timestamp (seconds) when the file was last synced. | 1755640000 | -| `id` | *str* | ✅ | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `object` | [components.ContainerFileObject](../components/containerfileobject.mdx) | ✅ | N/A | container.file | -| `path` | *str* | ✅ | Container-relative file path. | out/report.csv | -| `source` | [components.ContainerFileSource](../components/containerfilesource.mdx) | ✅ | Container files are always produced by the assistant sandbox. | assistant | \ No newline at end of file +| `bytes_` | *int* | :heavy_check_mark: | File size in bytes. | 123 | +| `container_id` | *str* | :heavy_check_mark: | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | +| `created_at` | *int* | :heavy_check_mark: | Unix timestamp (seconds) when the file was last synced. | 1755640000 | +| `id` | *str* | :heavy_check_mark: | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `object` | [components.ContainerFileObject](../components/containerfileobject.mdx) | :heavy_check_mark: | N/A | container.file | +| `path` | *str* | :heavy_check_mark: | Container-relative file path. | out/report.csv | +| `source` | [components.ContainerFileSource](../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/components/containerfilelistresponse.mdx b/docs/components/containerfilelistresponse.mdx index f3924a018..10eb459aa 100644 --- a/docs/components/containerfilelistresponse.mdx +++ b/docs/components/containerfilelistresponse.mdx @@ -6,8 +6,8 @@ title: "ContainerFileListResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.ContainerFile](../components/containerfile.mdx)] | ✅ | N/A | | -| `first_id` | *Nullable[str]* | ✅ | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | -| `has_more` | *bool* | ✅ | True when another page can be fetched by passing `after=last_id`; `last_id` is non-null whenever this is true. | false | -| `last_id` | *Nullable[str]* | ✅ | 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](../components/containerfilelistresponseobject.mdx) | ✅ | N/A | list | \ No newline at end of file +| `data` | List[[components.ContainerFile](../components/containerfile.mdx)] | :heavy_check_mark: | N/A | | +| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | +| `has_more` | *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 | +| `last_id` | *Nullable[str]* | :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](../components/containerfilelistresponseobject.mdx) | :heavy_check_mark: | N/A | list | \ No newline at end of file diff --git a/docs/components/containernetworkpolicyallowlist.mdx b/docs/components/containernetworkpolicyallowlist.mdx index 903c69971..985509288 100644 --- a/docs/components/containernetworkpolicyallowlist.mdx +++ b/docs/components/containernetworkpolicyallowlist.mdx @@ -6,5 +6,5 @@ title: "ContainerNetworkPolicyAllowlist" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_domains` | List[*str*] | ✅ | 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](../components/typeallowlist.mdx) | ✅ | Outbound access restricted to the listed domains. | | \ No newline at end of file +| `allowed_domains` | List[*str*] | :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](../components/typeallowlist.mdx) | :heavy_check_mark: | Outbound access restricted to the listed domains. | | \ No newline at end of file diff --git a/docs/components/containernetworkpolicydisabled.mdx b/docs/components/containernetworkpolicydisabled.mdx index 5ca7f102f..a2e14bd56 100644 --- a/docs/components/containernetworkpolicydisabled.mdx +++ b/docs/components/containernetworkpolicydisabled.mdx @@ -6,4 +6,4 @@ title: "ContainerNetworkPolicyDisabled" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [components.ContainerNetworkPolicyTypeDisabled](../components/containernetworkpolicytypedisabled.mdx) | ✅ | No outbound internet access. | \ No newline at end of file +| `type` | [components.ContainerNetworkPolicyTypeDisabled](../components/containernetworkpolicytypedisabled.mdx) | :heavy_check_mark: | No outbound internet access. | \ No newline at end of file diff --git a/docs/components/containerreferenceenvironment.mdx b/docs/components/containerreferenceenvironment.mdx index 9b4deaf6f..cd619d6ae 100644 --- a/docs/components/containerreferenceenvironment.mdx +++ b/docs/components/containerreferenceenvironment.mdx @@ -9,7 +9,7 @@ Reference to a container by its canonical id — a previously returned container | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | ✅ | 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 | -| `file_ids` | List[*str*] | ➖ | 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"
] | -| `network_policy` | [Optional[components.ContainerNetworkPolicy]](../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](../components/containerreferenceenvironmenttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `container_id` | *str* | :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 | +| `file_ids` | List[*str*] | :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"
] | +| `network_policy` | [Optional[components.ContainerNetworkPolicy]](../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](../components/containerreferenceenvironmenttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contentcompaction.mdx b/docs/components/contentcompaction.mdx index e583353ce..805357e1f 100644 --- a/docs/components/contentcompaction.mdx +++ b/docs/components/contentcompaction.mdx @@ -6,7 +6,7 @@ title: "ContentCompaction" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *Nullable[str]* | ✅ | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | -| `type` | [components.MessagesMessageParamTypeCompaction](../components/messagesmessageparamtypecompaction.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.MessagesMessageParamTypeCompaction](../components/messagesmessageparamtypecompaction.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contentencryptedcontent.mdx b/docs/components/contentencryptedcontent.mdx index 76af85cec..450638f0c 100644 --- a/docs/components/contentencryptedcontent.mdx +++ b/docs/components/contentencryptedcontent.mdx @@ -6,6 +6,6 @@ title: "ContentEncryptedContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `encrypted_content` | *str* | ✅ | N/A | -| `type` | [components.TypeEncryptedContent](../components/typeencryptedcontent.mdx) | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `encrypted_content` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.TypeEncryptedContent](../components/typeencryptedcontent.mdx) | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/contentfilterbuiltinentry.mdx b/docs/components/contentfilterbuiltinentry.mdx index 2696f30d9..48678dc2c 100644 --- a/docs/components/contentfilterbuiltinentry.mdx +++ b/docs/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](../components/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | -| `label` | *Optional[str]* | ➖ | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | -| `scan_scope` | [Optional[components.PromptInjectionScanScope]](../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](../components/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `action` | [components.ContentFilterBuiltinAction](../components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | +| `label` | *Optional[str]* | :heavy_minus_sign: | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | +| `scan_scope` | [Optional[components.PromptInjectionScanScope]](../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](../components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/components/contentfilterbuiltinentryinput.mdx b/docs/components/contentfilterbuiltinentryinput.mdx index 9753f4521..28e250251 100644 --- a/docs/components/contentfilterbuiltinentryinput.mdx +++ b/docs/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](../components/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | -| ~~`label`~~ | *Optional[str]* | ➖ | : 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. | | -| `scan_scope` | [Optional[components.PromptInjectionScanScope]](../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](../components/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `action` | [components.ContentFilterBuiltinAction](../components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | +| ~~`label`~~ | *Optional[str]* | :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. | | +| `scan_scope` | [Optional[components.PromptInjectionScanScope]](../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](../components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/components/contentfilterentry.mdx b/docs/components/contentfilterentry.mdx index 0fe2bbd9f..c8165e83a 100644 --- a/docs/components/contentfilterentry.mdx +++ b/docs/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](../components/contentfilteraction.mdx) | ✅ | Action taken when the pattern matches | block | -| `label` | *OptionalNullable[str]* | ➖ | Optional label used in redaction placeholders or error messages | [API_KEY] | -| `pattern` | *str* | ✅ | 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](../components/contentfilteraction.mdx) | :heavy_check_mark: | Action taken when the pattern matches | block | +| `label` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional label used in redaction placeholders or error messages | [API_KEY] | +| `pattern` | *str* | :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/components/contentimageurl.mdx b/docs/components/contentimageurl.mdx index 69aea2915..41aae9e0e 100644 --- a/docs/components/contentimageurl.mdx +++ b/docs/components/contentimageurl.mdx @@ -6,5 +6,5 @@ title: "ContentImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `image_url` | [components.ContentImageURLImageURL](../components/contentimageurlimageurl.mdx) | ✅ | N/A | -| `type` | [components.FileTypeImageURL](../components/filetypeimageurl.mdx) | ✅ | N/A | \ No newline at end of file +| `image_url` | [components.ContentImageURLImageURL](../components/contentimageurlimageurl.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.FileTypeImageURL](../components/filetypeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentimageurlimageurl.mdx b/docs/components/contentimageurlimageurl.mdx index 272d214d6..dc4af4688 100644 --- a/docs/components/contentimageurlimageurl.mdx +++ b/docs/components/contentimageurlimageurl.mdx @@ -6,4 +6,4 @@ title: "ContentImageURLImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentpartaddedevent.mdx b/docs/components/contentpartaddedevent.mdx index 1b157f83d..a62904e2c 100644 --- a/docs/components/contentpartaddedevent.mdx +++ b/docs/components/contentpartaddedevent.mdx @@ -9,9 +9,9 @@ Event emitted when a new content part is added to an output item | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `content_index` | *int* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `part` | [components.ContentPartAddedEventPart](../components/contentpartaddedeventpart.mdx) | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ContentPartAddedEventType](../components/contentpartaddedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content_index` | *int* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `part` | [components.ContentPartAddedEventPart](../components/contentpartaddedeventpart.mdx) | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ContentPartAddedEventType](../components/contentpartaddedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentpartaudio.mdx b/docs/components/contentpartaudio.mdx index 434006143..1a97cd731 100644 --- a/docs/components/contentpartaudio.mdx +++ b/docs/components/contentpartaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartAudio" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `audio_url` | [components.AudioURL](../components/audiourl.mdx) | ✅ | N/A | -| `type` | [components.ContentPartAudioType](../components/contentpartaudiotype.mdx) | ✅ | N/A | \ No newline at end of file +| `audio_url` | [components.AudioURL](../components/audiourl.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.ContentPartAudioType](../components/contentpartaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentpartdoneevent.mdx b/docs/components/contentpartdoneevent.mdx index 2016f8ba0..39c938493 100644 --- a/docs/components/contentpartdoneevent.mdx +++ b/docs/components/contentpartdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when a content part is complete | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `content_index` | *int* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `part` | [components.ContentPartDoneEventPart](../components/contentpartdoneeventpart.mdx) | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ContentPartDoneEventType](../components/contentpartdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content_index` | *int* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `part` | [components.ContentPartDoneEventPart](../components/contentpartdoneeventpart.mdx) | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ContentPartDoneEventType](../components/contentpartdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentpartimage.mdx b/docs/components/contentpartimage.mdx index 6fbcf61db..d4adef710 100644 --- a/docs/components/contentpartimage.mdx +++ b/docs/components/contentpartimage.mdx @@ -6,5 +6,5 @@ title: "ContentPartImage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `image_url` | [components.ContentPartImageImageURL](../components/contentpartimageimageurl.mdx) | ✅ | N/A | -| `type` | [components.ContentPartImageType](../components/contentpartimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `image_url` | [components.ContentPartImageImageURL](../components/contentpartimageimageurl.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.ContentPartImageType](../components/contentpartimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentpartimageimageurl.mdx b/docs/components/contentpartimageimageurl.mdx index 91bbc14d0..248d1b880 100644 --- a/docs/components/contentpartimageimageurl.mdx +++ b/docs/components/contentpartimageimageurl.mdx @@ -6,4 +6,4 @@ title: "ContentPartImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentpartinputaudio.mdx b/docs/components/contentpartinputaudio.mdx index a42a4daa9..08619de7f 100644 --- a/docs/components/contentpartinputaudio.mdx +++ b/docs/components/contentpartinputaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputAudio" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `input_audio` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `type` | [components.ContentPartInputAudioType](../components/contentpartinputaudiotype.mdx) | ✅ | N/A | | \ No newline at end of file +| `input_audio` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `type` | [components.ContentPartInputAudioType](../components/contentpartinputaudiotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contentpartinputfile.mdx b/docs/components/contentpartinputfile.mdx index 1037d15ca..de674503d 100644 --- a/docs/components/contentpartinputfile.mdx +++ b/docs/components/contentpartinputfile.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputFile" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `input_file` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `type` | [components.ContentPartInputFileType](../components/contentpartinputfiletype.mdx) | ✅ | N/A | | \ No newline at end of file +| `input_file` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `type` | [components.ContentPartInputFileType](../components/contentpartinputfiletype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contentpartinputvideo.mdx b/docs/components/contentpartinputvideo.mdx index 4443ed305..0d846f378 100644 --- a/docs/components/contentpartinputvideo.mdx +++ b/docs/components/contentpartinputvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputVideo" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `input_video` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `type` | [components.ContentPartInputVideoType](../components/contentpartinputvideotype.mdx) | ✅ | N/A | | \ No newline at end of file +| `input_video` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `type` | [components.ContentPartInputVideoType](../components/contentpartinputvideotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contentpartvideo.mdx b/docs/components/contentpartvideo.mdx index 1b05c01c2..058640db3 100644 --- a/docs/components/contentpartvideo.mdx +++ b/docs/components/contentpartvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartVideo" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [components.ContentPartVideoType](../components/contentpartvideotype.mdx) | ✅ | N/A | -| `video_url` | [components.VideoURL](../components/videourl.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.ContentPartVideoType](../components/contentpartvideotype.mdx) | :heavy_check_mark: | N/A | +| `video_url` | [components.VideoURL](../components/videourl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentredactedthinking.mdx b/docs/components/contentredactedthinking.mdx index c399abdce..03ca5bcd3 100644 --- a/docs/components/contentredactedthinking.mdx +++ b/docs/components/contentredactedthinking.mdx @@ -6,5 +6,5 @@ title: "ContentRedactedThinking" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `data` | *str* | ✅ | N/A | -| `type` | [components.MessagesMessageParamTypeRedactedThinking](../components/messagesmessageparamtyperedactedthinking.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesMessageParamTypeRedactedThinking](../components/messagesmessageparamtyperedactedthinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentservertooluse.mdx b/docs/components/contentservertooluse.mdx index a95b27f9d..c2377ff20 100644 --- a/docs/components/contentservertooluse.mdx +++ b/docs/components/contentservertooluse.mdx @@ -6,8 +6,8 @@ title: "ContentServerToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *str* | ✅ | N/A | | -| `input` | *Optional[Any]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `type` | [components.MessagesMessageParamTypeServerToolUse](../components/messagesmessageparamtypeservertooluse.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *str* | :heavy_check_mark: | N/A | | +| `input` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.MessagesMessageParamTypeServerToolUse](../components/messagesmessageparamtypeservertooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contenttext.mdx b/docs/components/contenttext.mdx index a3be2c26a..cfdd29eea 100644 --- a/docs/components/contenttext.mdx +++ b/docs/components/contenttext.mdx @@ -6,5 +6,5 @@ title: "ContentText" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `text` | *str* | ✅ | N/A | -| `type` | [components.FileTypeText](../components/filetypetext.mdx) | ✅ | N/A | \ No newline at end of file +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.FileTypeText](../components/filetypetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentthinking.mdx b/docs/components/contentthinking.mdx index 37f09585c..a7921fd6a 100644 --- a/docs/components/contentthinking.mdx +++ b/docs/components/contentthinking.mdx @@ -6,6 +6,6 @@ title: "ContentThinking" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `signature` | *str* | ✅ | N/A | -| `thinking` | *str* | ✅ | N/A | -| `type` | [components.MessagesMessageParamTypeThinking](../components/messagesmessageparamtypethinking.mdx) | ✅ | N/A | \ No newline at end of file +| `signature` | *str* | :heavy_check_mark: | N/A | +| `thinking` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesMessageParamTypeThinking](../components/messagesmessageparamtypethinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contenttoolreference.mdx b/docs/components/contenttoolreference.mdx index 5d5c366eb..bc1e04237 100644 --- a/docs/components/contenttoolreference.mdx +++ b/docs/components/contenttoolreference.mdx @@ -6,5 +6,5 @@ title: "ContentToolReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `tool_name` | *str* | ✅ | N/A | -| `type` | [components.MessagesMessageParamTypeToolReference](../components/messagesmessageparamtypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `tool_name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesMessageParamTypeToolReference](../components/messagesmessageparamtypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contenttoolresult.mdx b/docs/components/contenttoolresult.mdx index e2e7acc45..f83588a9c 100644 --- a/docs/components/contenttoolresult.mdx +++ b/docs/components/contenttoolresult.mdx @@ -6,8 +6,8 @@ title: "ContentToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.MessagesMessageParamContentUnion2]](../components/messagesmessageparamcontentunion2.mdx) | ➖ | N/A | | -| `is_error` | *Optional[bool]* | ➖ | N/A | | -| `tool_use_id` | *str* | ✅ | N/A | | -| `type` | [components.TypeToolResult](../components/typetoolresult.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.MessagesMessageParamContentUnion2]](../components/messagesmessageparamcontentunion2.mdx) | :heavy_minus_sign: | N/A | | +| `is_error` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.TypeToolResult](../components/typetoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contenttooluse.mdx b/docs/components/contenttooluse.mdx index bbc977327..fcb072536 100644 --- a/docs/components/contenttooluse.mdx +++ b/docs/components/contenttooluse.mdx @@ -6,8 +6,8 @@ title: "ContentToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *str* | ✅ | N/A | | -| `input` | *Optional[Any]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `type` | [components.MessagesMessageParamTypeToolUse](../components/messagesmessageparamtypetooluse.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *str* | :heavy_check_mark: | N/A | | +| `input` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.MessagesMessageParamTypeToolUse](../components/messagesmessageparamtypetooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contenttoplogprob.mdx b/docs/components/contenttoplogprob.mdx index 73a010f25..5ac97a3d8 100644 --- a/docs/components/contenttoplogprob.mdx +++ b/docs/components/contenttoplogprob.mdx @@ -6,6 +6,6 @@ title: "ContentTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | ✅ | N/A | -| `logprob` | *float* | ✅ | N/A | -| `token` | *str* | ✅ | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | +| `logprob` | *float* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contentwebsearchtoolresult.mdx b/docs/components/contentwebsearchtoolresult.mdx index a87188438..3f3b1c7fe 100644 --- a/docs/components/contentwebsearchtoolresult.mdx +++ b/docs/components/contentwebsearchtoolresult.mdx @@ -6,7 +6,7 @@ title: "ContentWebSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagesmessageparamcontentunion3.mdx) | ✅ | N/A | | -| `tool_use_id` | *str* | ✅ | N/A | | -| `type` | [components.MessagesMessageParamTypeWebSearchToolResult](../components/messagesmessageparamtypewebsearchtoolresult.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagesmessageparamcontentunion3.mdx) | :heavy_check_mark: | N/A | | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.MessagesMessageParamTypeWebSearchToolResult](../components/messagesmessageparamtypewebsearchtoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contentwebsearchtoolresulterror.mdx b/docs/components/contentwebsearchtoolresulterror.mdx index 43c06d580..ab974796c 100644 --- a/docs/components/contentwebsearchtoolresulterror.mdx +++ b/docs/components/contentwebsearchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "ContentWebSearchToolResultError" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `error_code` | [components.MessagesMessageParamErrorCode](../components/messagesmessageparamerrorcode.mdx) | ✅ | N/A | -| `type` | [components.MessagesMessageParamTypeWebSearchToolResultError](../components/messagesmessageparamtypewebsearchtoolresulterror.mdx) | ✅ | N/A | \ No newline at end of file +| `error_code` | [components.MessagesMessageParamErrorCode](../components/messagesmessageparamerrorcode.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.MessagesMessageParamTypeWebSearchToolResultError](../components/messagesmessageparamtypewebsearchtoolresulterror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/contextcompactionitem.mdx b/docs/components/contextcompactionitem.mdx index e72fa1292..369dd320c 100644 --- a/docs/components/contextcompactionitem.mdx +++ b/docs/components/contextcompactionitem.mdx @@ -9,7 +9,7 @@ A context compaction marker with an optional encrypted summary | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `type` | [components.ContextCompactionItemType](../components/contextcompactionitemtype.mdx) | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file +| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.ContextCompactionItemType](../components/contextcompactionitemtype.mdx) | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file diff --git a/docs/components/contextcompressionplugin.mdx b/docs/components/contextcompressionplugin.mdx index 18ea3a4f1..a502a991a 100644 --- a/docs/components/contextcompressionplugin.mdx +++ b/docs/components/contextcompressionplugin.mdx @@ -6,6 +6,6 @@ title: "ContextCompressionPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `enabled` | *Optional[bool]* | ➖ | Set to false to disable the context-compression plugin for this request. Defaults to true. | | -| `engine` | [Optional[components.ContextCompressionEngine]](../components/contextcompressionengine.mdx) | ➖ | The compression engine to use. Defaults to "middle-out". | middle-out | -| `id` | [components.ContextCompressionPluginID](../components/contextcompressionpluginid.mdx) | ✅ | N/A | | \ No newline at end of file +| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. | | +| `engine` | [Optional[components.ContextCompressionEngine]](../components/contextcompressionengine.mdx) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | +| `id` | [components.ContextCompressionPluginID](../components/contextcompressionpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/contextmanagement.mdx b/docs/components/contextmanagement.mdx index 650489879..521afd6c8 100644 --- a/docs/components/contextmanagement.mdx +++ b/docs/components/contextmanagement.mdx @@ -6,4 +6,4 @@ title: "ContextManagement" | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `edits` | List[[components.Edit](../components/edit.mdx)] | ➖ | N/A | \ No newline at end of file +| `edits` | List[[components.Edit](../components/edit.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/contradiction.mdx b/docs/components/contradiction.mdx index 9bcbab36d..df0f53d79 100644 --- a/docs/components/contradiction.mdx +++ b/docs/components/contradiction.mdx @@ -6,5 +6,5 @@ title: "Contradiction" | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `stances` | List[[components.Stance](../components/stance.mdx)] | ✅ | N/A | -| `topic` | *str* | ✅ | N/A | \ No newline at end of file +| `stances` | List[[components.Stance](../components/stance.mdx)] | :heavy_check_mark: | N/A | +| `topic` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/costdetails.mdx b/docs/components/costdetails.mdx index 045bea41d..eeda364d2 100644 --- a/docs/components/costdetails.mdx +++ b/docs/components/costdetails.mdx @@ -9,7 +9,7 @@ Breakdown of upstream inference costs | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `server_tool_cost` | *OptionalNullable[float]* | ➖ | 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. | -| `upstream_inference_completions_cost` | *float* | ✅ | N/A | -| `upstream_inference_cost` | *OptionalNullable[float]* | ➖ | N/A | -| `upstream_inference_prompt_cost` | *float* | ✅ | N/A | \ No newline at end of file +| `server_tool_cost` | *OptionalNullable[float]* | :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. | +| `upstream_inference_completions_cost` | *float* | :heavy_check_mark: | N/A | +| `upstream_inference_cost` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `upstream_inference_prompt_cost` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/createbyokkeyrequest.mdx b/docs/components/createbyokkeyrequest.mdx index 649b7eea5..360386f6f 100644 --- a/docs/components/createbyokkeyrequest.mdx +++ b/docs/components/createbyokkeyrequest.mdx @@ -6,16 +6,16 @@ title: "CreateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_api_key_hashes` | List[*str*] | ➖ | 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"
] | -| `allowed_models` | List[*str*] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declared_region` | [OptionalNullable[components.CreateBYOKKeyRequestDeclaredRegion]](../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 | -| `declared_zdr` | *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` | *Optional[bool]* | ➖ | Whether this credential should be created in a disabled state. | false | -| `is_byok_only` | *Optional[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 | -| `is_fallback` | *Optional[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 | -| `is_required` | *Optional[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` | *str* | ✅ | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | -| `name` | *OptionalNullable[str]* | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [components.BYOKProviderSlug](../components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `workspace_id` | *Optional[str]* | ➖ | 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 +| `allowed_api_key_hashes` | List[*str*] | :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"
] | +| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declared_region` | [OptionalNullable[components.CreateBYOKKeyRequestDeclaredRegion]](../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 | +| `declared_zdr` | *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | +| `is_byok_only` | *Optional[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 | +| `is_fallback` | *Optional[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 | +| `is_required` | *Optional[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` | *str* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | +| `provider` | [components.BYOKProviderSlug](../components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `workspace_id` | *Optional[str]* | :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/components/createbyokkeyresponse.mdx b/docs/components/createbyokkeyresponse.mdx index 6ac8473de..4da6fbee6 100644 --- a/docs/components/createbyokkeyresponse.mdx +++ b/docs/components/createbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "CreateBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.BYOKKey](../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](../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/components/createenduserrequest.mdx b/docs/components/createenduserrequest.mdx index b81900546..9d28e4c7e 100644 --- a/docs/components/createenduserrequest.mdx +++ b/docs/components/createenduserrequest.mdx @@ -6,4 +6,4 @@ title: "CreateEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | ✅ | 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` | *str* | :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/components/createguardrailrequest.mdx b/docs/components/createguardrailrequest.mdx index 7724e0e55..fbc52a249 100644 --- a/docs/components/createguardrailrequest.mdx +++ b/docs/components/createguardrailrequest.mdx @@ -6,25 +6,26 @@ title: "CreateGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | -| `allowed_models` | List[*str*] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `allowed_providers` | List[*str*] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../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[str]* | ➖ | Description of the guardrail | A guardrail for limiting API usage | -| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`enforce_zdr`~~ | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `ignored_models` | List[*str*] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *OptionalNullable[float]* | ➖ | 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` | *str* | ✅ | Name for the new guardrail | My New Guardrail | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `workspace_id` | *Optional[str]* | ➖ | 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 +| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | true | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | +| `allowed_models` | List[*str*] | :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"
] | +| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../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[str]* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | +| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`enforce_zdr`~~ | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *OptionalNullable[float]* | :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` | *str* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `workspace_id` | *Optional[str]* | :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/components/createguardrailresponse.mdx b/docs/components/createguardrailresponse.mdx index 9a5116dff..63cc820d2 100644 --- a/docs/components/createguardrailresponse.mdx +++ b/docs/components/createguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "CreateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Guardrail](../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](../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/components/createinternrequest.mdx b/docs/components/createinternrequest.mdx index e85bd9bc3..28e8aee5c 100644 --- a/docs/components/createinternrequest.mdx +++ b/docs/components/createinternrequest.mdx @@ -9,9 +9,9 @@ Settings for a new intern. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | ➖ | Free-form description, or null. | -| `instructions` | *OptionalNullable[str]* | ➖ | Standing instructions the intern boots with, or null. | -| `name` | *str* | ✅ | Intern name, unique per creator within the workspace. | -| `provision` | *Optional[bool]* | ➖ | Start provisioning during this create operation. Defaults to false. | -| `vault_id` | *Optional[str]* | ➖ | Vault owned by another intern in this workspace to attach as a borrowed vault. | -| `workspace_id` | *Optional[str]* | ➖ | 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[str]* | :heavy_minus_sign: | Free-form description, or null. | +| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | Standing instructions the intern boots with, or null. | +| `name` | *str* | :heavy_check_mark: | Intern name, unique per creator within the workspace. | +| `provision` | *Optional[bool]* | :heavy_minus_sign: | Start provisioning during this create operation. Defaults to false. | +| `vault_id` | *Optional[str]* | :heavy_minus_sign: | Vault owned by another intern in this workspace to attach as a borrowed vault. | +| `workspace_id` | *Optional[str]* | :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/components/createobservabilitydestinationrequest.mdx b/docs/components/createobservabilitydestinationrequest.mdx index 8ee0ef342..1eb1a6577 100644 --- a/docs/components/createobservabilitydestinationrequest.mdx +++ b/docs/components/createobservabilitydestinationrequest.mdx @@ -6,17 +6,17 @@ title: "CreateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ➖ | 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 | -| `broadcast_generation_cost` | *Optional[bool]* | ➖ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *Optional[bool]* | ➖ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *Optional[bool]* | ➖ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *Optional[bool]* | ➖ | When true, include request-context generation metadata. | false | -| `config` | Dict[str, *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` | *Optional[bool]* | ➖ | Whether this destination should be enabled immediately. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../components/observabilityfilterrulesconfignullable.mdx) | ➖ | Optional structured filter rules controlling which events are forwarded. | null | -| `name` | *str* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *Optional[bool]* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegionInput](../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"
] | -| `sampling_rate` | *Optional[float]* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.CreateObservabilityDestinationRequestType](../components/createobservabilitydestinationrequesttype.mdx) | ✅ | The destination type. Only stable destination types are accepted. | langfuse | -| `workspace_id` | *Optional[str]* | ➖ | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *Optional[bool]* | :heavy_minus_sign: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *Optional[bool]* | :heavy_minus_sign: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *Optional[bool]* | :heavy_minus_sign: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *Optional[bool]* | :heavy_minus_sign: | When true, include request-context generation metadata. | false | +| `config` | Dict[str, *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | +| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../components/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | +| `name` | *str* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegionInput](../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"
] | +| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.CreateObservabilityDestinationRequestType](../components/createobservabilitydestinationrequesttype.mdx) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | +| `workspace_id` | *Optional[str]* | :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/components/createobservabilitydestinationresponse.mdx b/docs/components/createobservabilitydestinationresponse.mdx index a631492fa..ed1fe6b03 100644 --- a/docs/components/createobservabilitydestinationresponse.mdx +++ b/docs/components/createobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "CreateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ObservabilityDestination](../components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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](../components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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/components/createpresetfrominferenceresponse.mdx b/docs/components/createpresetfrominferenceresponse.mdx index 8b76124d4..c31f263d2 100644 --- a/docs/components/createpresetfrominferenceresponse.mdx +++ b/docs/components/createpresetfrominferenceresponse.mdx @@ -9,4 +9,4 @@ Response containing the created preset with its designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.PresetWithDesignatedVersion](../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](../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/components/createprivateendpointrequest.mdx b/docs/components/createprivateendpointrequest.mdx index 8cd673de2..6c0147e3a 100644 --- a/docs/components/createprivateendpointrequest.mdx +++ b/docs/components/createprivateendpointrequest.mdx @@ -6,11 +6,11 @@ title: "CreatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `activate` | [Optional[components.PrivateEndpointActivation]](../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"
} | -| `base_url` | *Optional[str]* | ➖ | 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 | -| `declared_region` | [OptionalNullable[components.CreatePrivateEndpointRequestDeclaredRegion]](../components/createprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | -| `declared_zdr` | *OptionalNullable[bool]* | ➖ | Attest that this deployment retains no prompt or completion data. | | -| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `pricing` | [Optional[components.PrivateEndpointPricing]](../components/privateendpointpricing.mdx) | ➖ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `provider_slug` | *str* | ✅ | Slug of the upstream provider. | azure | -| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `activate` | [Optional[components.PrivateEndpointActivation]](../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"
} | +| `base_url` | *Optional[str]* | :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 | +| `declared_region` | [OptionalNullable[components.CreatePrivateEndpointRequestDeclaredRegion]](../components/createprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | +| `declared_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | +| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `pricing` | [Optional[components.PrivateEndpointPricing]](../components/privateendpointpricing.mdx) | :heavy_minus_sign: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `provider_slug` | *str* | :heavy_check_mark: | Slug of the upstream provider. | azure | +| `upstream_model_id` | *str* | :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/components/createprivateendpointvalidationfailedresponsedata.mdx b/docs/components/createprivateendpointvalidationfailedresponsedata.mdx index 6801e68d6..eff4f07a0 100644 --- a/docs/components/createprivateendpointvalidationfailedresponsedata.mdx +++ b/docs/components/createprivateendpointvalidationfailedresponsedata.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseData" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `endpoint` | [components.ManagedPrivateEndpoint](../components/managedprivateendpoint.mdx) | ✅ | N/A | -| `validation` | [Nullable[components.PrivateEndpointValidationNullable]](../components/privateendpointvalidationnullable.mdx) | ✅ | N/A | \ No newline at end of file +| `endpoint` | [components.ManagedPrivateEndpoint](../components/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | +| `validation` | [Nullable[components.PrivateEndpointValidationNullable]](../components/privateendpointvalidationnullable.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/createprivateendpointvalidationfailedresponseerror.mdx b/docs/components/createprivateendpointvalidationfailedresponseerror.mdx index 7175c4302..40ca96c87 100644 --- a/docs/components/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/components/createprivateendpointvalidationfailedresponseerror.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/createscimgroupmappingrequest.mdx b/docs/components/createscimgroupmappingrequest.mdx index 6264cfcc6..5ad1269cb 100644 --- a/docs/components/createscimgroupmappingrequest.mdx +++ b/docs/components/createscimgroupmappingrequest.mdx @@ -6,6 +6,6 @@ title: "CreateScimGroupMappingRequest" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `role` | [components.CreateScimGroupMappingRequestRole](../components/createscimgroupmappingrequestrole.mdx) | ✅ | N/A | -| `scim_group_id` | *str* | ✅ | N/A | -| `workspace_id` | *str* | ✅ | N/A | \ No newline at end of file +| `role` | [components.CreateScimGroupMappingRequestRole](../components/createscimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | +| `scim_group_id` | *str* | :heavy_check_mark: | N/A | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/createscimgroupmappingresponse.mdx b/docs/components/createscimgroupmappingresponse.mdx index 72db3ce1a..9ac0db3fb 100644 --- a/docs/components/createscimgroupmappingresponse.mdx +++ b/docs/components/createscimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "CreateScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ScimGroupMapping](../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](../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/components/createscimsyncjobresponse.mdx b/docs/components/createscimsyncjobresponse.mdx index 60f934c6c..578411c9c 100644 --- a/docs/components/createscimsyncjobresponse.mdx +++ b/docs/components/createscimsyncjobresponse.mdx @@ -6,4 +6,4 @@ title: "CreateScimSyncJobResponse" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | [components.ScimSyncJob](../components/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.ScimSyncJob](../components/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/createworkspacerequest.mdx b/docs/components/createworkspacerequest.mdx index 26c15d610..2d5e28682 100644 --- a/docs/components/createworkspacerequest.mdx +++ b/docs/components/createworkspacerequest.mdx @@ -6,15 +6,15 @@ title: "CreateWorkspaceRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `default_image_model` | *OptionalNullable[str]* | ➖ | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | ➖ | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | ➖ | Description of the workspace | Production environment workspace | -| `disabled_server_tools` | List[[components.CreateWorkspaceRequestDisabledServerTool](../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"
] | -| `io_logging_api_key_ids` | List[*int*] | ➖ | Optional array of API key IDs to filter I/O logging | null | -| `io_logging_sampling_rate` | *Optional[float]* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | ➖ | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | ➖ | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | ➖ | Whether private logging is enabled | false | -| `name` | *str* | ✅ | Name for the new workspace | Production | -| `slug` | *str* | ✅ | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file +| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the workspace | Production environment workspace | +| `disabled_server_tools` | List[[components.CreateWorkspaceRequestDisabledServerTool](../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"
] | +| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | +| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | +| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | +| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | +| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | +| `name` | *str* | :heavy_check_mark: | Name for the new workspace | Production | +| `slug` | *str* | :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/components/createworkspaceresponse.mdx b/docs/components/createworkspaceresponse.mdx index 65fb4c548..27d6f40a6 100644 --- a/docs/components/createworkspaceresponse.mdx +++ b/docs/components/createworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "CreateWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Workspace](../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](../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/components/customtool.mdx b/docs/components/customtool.mdx index 0912528e3..4254b4f61 100644 --- a/docs/components/customtool.mdx +++ b/docs/components/customtool.mdx @@ -9,9 +9,9 @@ Custom tool configuration | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | ➖ | N/A | | -| `description` | *Optional[str]* | ➖ | N/A | | -| `format_` | [Optional[components.Format]](../components/format_.mdx) | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `type` | [components.CustomToolTypeCustom](../components/customtooltypecustom.mdx) | ✅ | N/A | | \ No newline at end of file +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `format_` | [Optional[components.Format]](../components/format_.mdx) | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.CustomToolTypeCustom](../components/customtooltypecustom.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/customtoolcallinputdeltaevent.mdx b/docs/components/customtoolcallinputdeltaevent.mdx index 8eb38f216..4ff3cab64 100644 --- a/docs/components/customtoolcallinputdeltaevent.mdx +++ b/docs/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` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.CustomToolCallInputDeltaEventType](../components/customtoolcallinputdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.CustomToolCallInputDeltaEventType](../components/customtoolcallinputdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/customtoolcallinputdoneevent.mdx b/docs/components/customtoolcallinputdoneevent.mdx index 42d962c6b..9fa94a133 100644 --- a/docs/components/customtoolcallinputdoneevent.mdx +++ b/docs/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` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.CustomToolCallInputDoneEventType](../components/customtoolcallinputdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `input` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.CustomToolCallInputDoneEventType](../components/customtoolcallinputdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/customtoolcallitem.mdx b/docs/components/customtoolcallitem.mdx index 1ccbdfe9d..c7d8e13ed 100644 --- a/docs/components/customtoolcallitem.mdx +++ b/docs/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[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 | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `input` | *str* | ✅ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `namespace` | *OptionalNullable[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | -| `type` | [components.CustomToolCallItemType](../components/customtoolcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `async_` | *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 | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `input` | *str* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `namespace` | *OptionalNullable[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | +| `type` | [components.CustomToolCallItemType](../components/customtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/customtoolcalloutputitem.mdx b/docs/components/customtoolcalloutputitem.mdx index aaa13cd33..2e8dd6506 100644 --- a/docs/components/customtoolcalloutputitem.mdx +++ b/docs/components/customtoolcalloutputitem.mdx @@ -9,7 +9,7 @@ The output from a custom (freeform-grammar) tool call execution. Mirrors `functi | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | ✅ | N/A | -| `id` | *Optional[str]* | ➖ | N/A | -| `output` | [components.CustomToolCallOutputItemOutputUnion2](../components/customtoolcalloutputitemoutputunion2.mdx) | ✅ | N/A | -| `type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | ✅ | N/A | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `output` | [components.CustomToolCallOutputItemOutputUnion2](../components/customtoolcalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/customtoolcalloutputitemoutputinputimage.mdx b/docs/components/customtoolcalloutputitemoutputinputimage.mdx index b9ec1f0df..41ee3d26a 100644 --- a/docs/components/customtoolcalloutputitemoutputinputimage.mdx +++ b/docs/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](../components/customtoolcalloutputitemdetail.mdx) | ✅ | N/A | -| `file_id` | *OptionalNullable[str]* | ➖ | N/A | -| `image_url` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.CustomToolCallOutputItemOutputType](../components/customtoolcalloutputitemoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `detail` | [components.CustomToolCallOutputItemDetail](../components/customtoolcalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | +| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.CustomToolCallOutputItemOutputType](../components/customtoolcalloutputitemoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/dabenchmarkentry.mdx b/docs/components/dabenchmarkentry.mdx index c24022b0e..63238a9c4 100644 --- a/docs/components/dabenchmarkentry.mdx +++ b/docs/components/dabenchmarkentry.mdx @@ -9,8 +9,8 @@ A single Design Arena benchmark entry for a specific arena+category | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `arena` | *str* | ✅ | Arena type (e.g. models, builders, agents) | models | -| `category` | *str* | ✅ | Category within the arena (e.g. website, gamedev, uicomponent) | website | -| `elo` | *float* | ✅ | ELO rating from head-to-head arena battles | 1385.2 | -| `rank` | *int* | ✅ | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | -| `win_rate` | *float* | ✅ | Win rate percentage in arena battles | 62.5 | \ No newline at end of file +| `arena` | *str* | :heavy_check_mark: | Arena type (e.g. models, builders, agents) | models | +| `category` | *str* | :heavy_check_mark: | Category within the arena (e.g. website, gamedev, uicomponent) | website | +| `elo` | *float* | :heavy_check_mark: | ELO rating from head-to-head arena battles | 1385.2 | +| `rank` | *int* | :heavy_check_mark: | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | +| `win_rate` | *float* | :heavy_check_mark: | Win rate percentage in arena battles | 62.5 | \ No newline at end of file diff --git a/docs/components/datetimeservertool.mdx b/docs/components/datetimeservertool.mdx index c70b0aca8..af483becf 100644 --- a/docs/components/datetimeservertool.mdx +++ b/docs/components/datetimeservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: returns the current date and time | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `parameters` | [Optional[components.DatetimeServerToolConfig]](../components/datetimeservertoolconfig.mdx) | ➖ | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | -| `type` | [components.DatetimeServerToolType](../components/datetimeservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.DatetimeServerToolConfig]](../components/datetimeservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | +| `type` | [components.DatetimeServerToolType](../components/datetimeservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/datetimeservertoolconfig.mdx b/docs/components/datetimeservertoolconfig.mdx index 1fcc9a9bc..f2c289a39 100644 --- a/docs/components/datetimeservertoolconfig.mdx +++ b/docs/components/datetimeservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:datetime server tool | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `timezone` | *Optional[str]* | ➖ | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file +| `timezone` | *Optional[str]* | :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/components/debugevent.mdx b/docs/components/debugevent.mdx index 7e50b0633..fb80bd742 100644 --- a/docs/components/debugevent.mdx +++ b/docs/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](../components/debugeventdebug.mdx) | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.DebugEventType](../components/debugeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `debug` | [components.DebugEventDebug](../components/debugeventdebug.mdx) | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.DebugEventType](../components/debugeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/debugeventdebug.mdx b/docs/components/debugeventdebug.mdx index 112cf01ed..feaaf1f4a 100644 --- a/docs/components/debugeventdebug.mdx +++ b/docs/components/debugeventdebug.mdx @@ -6,5 +6,5 @@ title: "DebugEventDebug" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `echo_upstream_body` | Dict[str, *Any*] | ➖ | N/A | -| `timings` | [Optional[components.DebugEventTimings]](../components/debugeventtimings.mdx) | ➖ | N/A | \ No newline at end of file +| `echo_upstream_body` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `timings` | [Optional[components.DebugEventTimings]](../components/debugeventtimings.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/debugeventtimings.mdx b/docs/components/debugeventtimings.mdx index 4c22c0fa7..0d5b176d7 100644 --- a/docs/components/debugeventtimings.mdx +++ b/docs/components/debugeventtimings.mdx @@ -6,6 +6,6 @@ title: "DebugEventTimings" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `epoch_ms` | *int* | ✅ | N/A | -| `event` | [components.DebugEventEvent](../components/debugeventevent.mdx) | ✅ | N/A | -| `start_ms` | *int* | ✅ | N/A | \ No newline at end of file +| `epoch_ms` | *int* | :heavy_check_mark: | N/A | +| `event` | [components.DebugEventEvent](../components/debugeventevent.mdx) | :heavy_check_mark: | N/A | +| `start_ms` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/decisions.mdx b/docs/components/decisions.mdx index 2e96f6e1f..d68a93a6e 100644 --- a/docs/components/decisions.mdx +++ b/docs/components/decisions.mdx @@ -6,6 +6,6 @@ title: "Decisions" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/decisionschoiceanswer.mdx b/docs/components/decisionschoiceanswer.mdx index af8877b4a..a27de14af 100644 --- a/docs/components/decisionschoiceanswer.mdx +++ b/docs/components/decisionschoiceanswer.mdx @@ -6,7 +6,7 @@ title: "DecisionsChoiceAnswer" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `choice` | *str* | ✅ | N/A | -| `confidence` | *Optional[float]* | ➖ | N/A | -| `probabilities` | Dict[str, *float*] | ➖ | N/A | -| `type` | [components.DecisionsChoiceAnswerType](../components/decisionschoiceanswertype.mdx) | ✅ | N/A | \ No newline at end of file +| `choice` | *str* | :heavy_check_mark: | N/A | +| `confidence` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `probabilities` | Dict[str, *float*] | :heavy_minus_sign: | N/A | +| `type` | [components.DecisionsChoiceAnswerType](../components/decisionschoiceanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/decisionschoicequestion.mdx b/docs/components/decisionschoicequestion.mdx index ccc63b726..dfd098de0 100644 --- a/docs/components/decisionschoicequestion.mdx +++ b/docs/components/decisionschoicequestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsChoiceQuestion" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `criteria` | Dict[str, [Nullable[components.Criteria]](../components/criteria.mdx)] | ✅ | N/A | -| `instructions` | [components.DecisionsChoiceQuestionInstructions](../components/decisionschoicequestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | -| `type` | [components.DecisionsChoiceQuestionType](../components/decisionschoicequestiontype.mdx) | ✅ | N/A | \ No newline at end of file +| `criteria` | Dict[str, [Nullable[components.Criteria]](../components/criteria.mdx)] | :heavy_check_mark: | N/A | +| `instructions` | [components.DecisionsChoiceQuestionInstructions](../components/decisionschoicequestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | +| `type` | [components.DecisionsChoiceQuestionType](../components/decisionschoicequestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/decisionsnoulanswer.mdx b/docs/components/decisionsnoulanswer.mdx index c4759c7d0..d34f71c34 100644 --- a/docs/components/decisionsnoulanswer.mdx +++ b/docs/components/decisionsnoulanswer.mdx @@ -6,5 +6,5 @@ title: "DecisionsNoulAnswer" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `noul` | *float* | ✅ | N/A | -| `type` | [components.DecisionsNoulAnswerType](../components/decisionsnoulanswertype.mdx) | ✅ | N/A | \ No newline at end of file +| `noul` | *float* | :heavy_check_mark: | N/A | +| `type` | [components.DecisionsNoulAnswerType](../components/decisionsnoulanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/decisionsnoulquestion.mdx b/docs/components/decisionsnoulquestion.mdx index daba55872..bd0cd40b9 100644 --- a/docs/components/decisionsnoulquestion.mdx +++ b/docs/components/decisionsnoulquestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsNoulQuestion" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `criteria` | [Optional[components.DecisionsNoulQuestionCriteria]](../components/decisionsnoulquestioncriteria.mdx) | ➖ | N/A | -| `instructions` | [components.DecisionsNoulQuestionInstructions](../components/decisionsnoulquestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | -| `type` | [components.DecisionsNoulQuestionType](../components/decisionsnoulquestiontype.mdx) | ✅ | N/A | \ No newline at end of file +| `criteria` | [Optional[components.DecisionsNoulQuestionCriteria]](../components/decisionsnoulquestioncriteria.mdx) | :heavy_minus_sign: | N/A | +| `instructions` | [components.DecisionsNoulQuestionInstructions](../components/decisionsnoulquestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | +| `type` | [components.DecisionsNoulQuestionType](../components/decisionsnoulquestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/decisionsnoulquestioncriteria.mdx b/docs/components/decisionsnoulquestioncriteria.mdx index a318be63c..eafa2e834 100644 --- a/docs/components/decisionsnoulquestioncriteria.mdx +++ b/docs/components/decisionsnoulquestioncriteria.mdx @@ -6,5 +6,5 @@ title: "DecisionsNoulQuestionCriteria" | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `false` | [components.FalseT](../components/falset.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | -| `true` | [components.TrueT](../components/truet.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | \ No newline at end of file +| `false` | [components.FalseT](../components/falset.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | +| `true` | [components.TrueT](../components/truet.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/components/decisionsrequest.mdx b/docs/components/decisionsrequest.mdx index e84d801a9..a5f5e91cd 100644 --- a/docs/components/decisionsrequest.mdx +++ b/docs/components/decisionsrequest.mdx @@ -6,10 +6,10 @@ title: "DecisionsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *str* | ✅ | N/A | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `questions` | Dict[str, [components.Questions](../components/questions.mdx)] | ✅ | N/A | | -| `session_id` | *Optional[str]* | ➖ | 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](../components/state.mdx) | ✅ | The content to evaluate: a plain string, or a JSON object or array of related context. | | -| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | N/A | | \ No newline at end of file +| `model` | *str* | :heavy_check_mark: | N/A | | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `questions` | Dict[str, [components.Questions](../components/questions.mdx)] | :heavy_check_mark: | N/A | | +| `session_id` | *Optional[str]* | :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](../components/state.mdx) | :heavy_check_mark: | The content to evaluate: a plain string, or a JSON object or array of related context. | | +| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/decisionsresponse.mdx b/docs/components/decisionsresponse.mdx index baadcef52..cdd215386 100644 --- a/docs/components/decisionsresponse.mdx +++ b/docs/components/decisionsresponse.mdx @@ -6,8 +6,8 @@ title: "DecisionsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `answers` | Dict[str, [components.Answers](../components/answers.mdx)] | ✅ | N/A | -| `id` | *Optional[str]* | ➖ | N/A | -| `model` | *str* | ✅ | N/A | -| `provider` | *Optional[str]* | ➖ | N/A | -| `usage` | [components.DecisionsResponseUsage](../components/decisionsresponseusage.mdx) | ✅ | N/A | \ No newline at end of file +| `answers` | Dict[str, [components.Answers](../components/answers.mdx)] | :heavy_check_mark: | N/A | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | +| `provider` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `usage` | [components.DecisionsResponseUsage](../components/decisionsresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/decisionsresponseusage.mdx b/docs/components/decisionsresponseusage.mdx index ee6edf055..d89f6e717 100644 --- a/docs/components/decisionsresponseusage.mdx +++ b/docs/components/decisionsresponseusage.mdx @@ -6,6 +6,6 @@ title: "DecisionsResponseUsage" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `cost` | *Optional[float]* | ➖ | N/A | -| `input_tokens` | *int* | ✅ | N/A | -| `output_tokens` | *int* | ✅ | N/A | \ No newline at end of file +| `cost` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `input_tokens` | *int* | :heavy_check_mark: | N/A | +| `output_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/decisionsscoreanswer.mdx b/docs/components/decisionsscoreanswer.mdx index 31c57e29d..4bc4bdee2 100644 --- a/docs/components/decisionsscoreanswer.mdx +++ b/docs/components/decisionsscoreanswer.mdx @@ -6,8 +6,8 @@ title: "DecisionsScoreAnswer" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `confidence` | *Optional[float]* | ➖ | N/A | -| `legend` | Dict[str, [components.Legend](../components/legend.mdx)] | ➖ | N/A | -| `probabilities` | Dict[str, *float*] | ➖ | N/A | -| `score` | *float* | ✅ | N/A | -| `type` | [components.DecisionsScoreAnswerType](../components/decisionsscoreanswertype.mdx) | ✅ | N/A | \ No newline at end of file +| `confidence` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `legend` | Dict[str, [components.Legend](../components/legend.mdx)] | :heavy_minus_sign: | N/A | +| `probabilities` | Dict[str, *float*] | :heavy_minus_sign: | N/A | +| `score` | *float* | :heavy_check_mark: | N/A | +| `type` | [components.DecisionsScoreAnswerType](../components/decisionsscoreanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/decisionsscorequestion.mdx b/docs/components/decisionsscorequestion.mdx index 6568adb52..c261757bc 100644 --- a/docs/components/decisionsscorequestion.mdx +++ b/docs/components/decisionsscorequestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsScoreQuestion" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `criteria` | List[[components.Criterion](../components/criterion.mdx)] | ✅ | N/A | -| `instructions` | [components.DecisionsScoreQuestionInstructions](../components/decisionsscorequestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | -| `type` | [components.DecisionsScoreQuestionType](../components/decisionsscorequestiontype.mdx) | ✅ | N/A | \ No newline at end of file +| `criteria` | List[[components.Criterion](../components/criterion.mdx)] | :heavy_check_mark: | N/A | +| `instructions` | [components.DecisionsScoreQuestionInstructions](../components/decisionsscorequestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | +| `type` | [components.DecisionsScoreQuestionType](../components/decisionsscorequestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/defaultparameters.mdx b/docs/components/defaultparameters.mdx index 78c74a24e..6c502ac4c 100644 --- a/docs/components/defaultparameters.mdx +++ b/docs/components/defaultparameters.mdx @@ -9,9 +9,9 @@ Default parameters for this model | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | -| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | -| `repetition_penalty` | *OptionalNullable[float]* | ➖ | N/A | -| `temperature` | *OptionalNullable[float]* | ➖ | N/A | -| `top_k` | *OptionalNullable[int]* | ➖ | N/A | -| `top_p` | *OptionalNullable[float]* | ➖ | N/A | \ No newline at end of file +| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `repetition_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `top_k` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | +| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/deferredbm25search.mdx b/docs/components/deferredbm25search.mdx index 191d4ae75..6cc32f8b5 100644 --- a/docs/components/deferredbm25search.mdx +++ b/docs/components/deferredbm25search.mdx @@ -9,5 +9,5 @@ Deterministic BM25 retrieval over supplied tool definitions. | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `max_results` | *Optional[int]* | ➖ | N/A | -| `type` | [components.DeferredBm25SearchType](../components/deferredbm25searchtype.mdx) | ✅ | N/A | \ No newline at end of file +| `max_results` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `type` | [components.DeferredBm25SearchType](../components/deferredbm25searchtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/deferredcustomsearch.mdx b/docs/components/deferredcustomsearch.mdx index e74d5af88..eeac494ae 100644 --- a/docs/components/deferredcustomsearch.mdx +++ b/docs/components/deferredcustomsearch.mdx @@ -9,7 +9,7 @@ Caller-executed search returning existing tool identities under result_key. | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `max_results` | *Optional[int]* | ➖ | N/A | -| `result_key` | *str* | ✅ | N/A | -| `tool_id` | *str* | ✅ | N/A | -| `type` | [components.DeferredCustomSearchType](../components/deferredcustomsearchtype.mdx) | ✅ | N/A | \ No newline at end of file +| `max_results` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `result_key` | *str* | :heavy_check_mark: | N/A | +| `tool_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.DeferredCustomSearchType](../components/deferredcustomsearchtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/deferredregexsearch.mdx b/docs/components/deferredregexsearch.mdx index 7ababe0f7..0687fb6b5 100644 --- a/docs/components/deferredregexsearch.mdx +++ b/docs/components/deferredregexsearch.mdx @@ -9,5 +9,5 @@ Versioned safe-regex retrieval over supplied tool definitions. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `max_results` | *Optional[int]* | ➖ | N/A | -| `type` | [components.DeferredRegexSearchType](../components/deferredregexsearchtype.mdx) | ✅ | N/A | \ No newline at end of file +| `max_results` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `type` | [components.DeferredRegexSearchType](../components/deferredregexsearchtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/deferredtoolscontrol.mdx b/docs/components/deferredtoolscontrol.mdx index 29aa1a5c1..c49a0ba01 100644 --- a/docs/components/deferredtoolscontrol.mdx +++ b/docs/components/deferredtoolscontrol.mdx @@ -9,7 +9,7 @@ Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `profile` | [components.Profile](../components/profile.mdx) | ✅ | Loading profile. Only `portable` is available in this release: OpenRouter serves deferral with router-built search and call wrappers on any model. | | -| `protocol` | [components.Protocol](../components/protocol.mdx) | ✅ | N/A | | -| `search` | [components.DeferredToolsSearchStrategy](../components/deferredtoolssearchstrategy.mdx) | ✅ | Router-local regex/BM25 or caller-owned custom search. | \{
"max_results": 5,
"type": "bm25"
} | -| `validation` | [components.Validation](../components/validation.mdx) | ✅ | Where tool-call arguments are checked against the original schema. Only `runtime` (in OpenRouter) is available in this release. | | \ No newline at end of file +| `profile` | [components.Profile](../components/profile.mdx) | :heavy_check_mark: | Loading profile. Only `portable` is available in this release: OpenRouter serves deferral with router-built search and call wrappers on any model. | | +| `protocol` | [components.Protocol](../components/protocol.mdx) | :heavy_check_mark: | N/A | | +| `search` | [components.DeferredToolsSearchStrategy](../components/deferredtoolssearchstrategy.mdx) | :heavy_check_mark: | Router-local regex/BM25 or caller-owned custom search. | \{
"max_results": 5,
"type": "bm25"
} | +| `validation` | [components.Validation](../components/validation.mdx) | :heavy_check_mark: | Where tool-call arguments are checked against the original schema. Only `runtime` (in OpenRouter) is available in this release. | | \ No newline at end of file diff --git a/docs/components/deletebyokkeyresponse.mdx b/docs/components/deletebyokkeyresponse.mdx index f2372798a..f1c80d265 100644 --- a/docs/components/deletebyokkeyresponse.mdx +++ b/docs/components/deletebyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `deleted` | *Literal[True]* | ✅ | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file +| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file diff --git a/docs/components/deleteguardrailresponse.mdx b/docs/components/deleteguardrailresponse.mdx index 12db72407..36069a963 100644 --- a/docs/components/deleteguardrailresponse.mdx +++ b/docs/components/deleteguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteGuardrailResponse" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *Literal[True]* | ✅ | Confirmation that the guardrail was deleted | true | \ No newline at end of file +| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/docs/components/deleteinternrequest.mdx b/docs/components/deleteinternrequest.mdx index 8323d82fd..3b870d4dd 100644 --- a/docs/components/deleteinternrequest.mdx +++ b/docs/components/deleteinternrequest.mdx @@ -9,4 +9,4 @@ Optional consent for a teardown that discards the workspace. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `acknowledge_workspace_loss` | *Optional[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 +| `acknowledge_workspace_loss` | *Optional[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/components/deleteinternresponse.mdx b/docs/components/deleteinternresponse.mdx index c24e52427..dcf556fcd 100644 --- a/docs/components/deleteinternresponse.mdx +++ b/docs/components/deleteinternresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `deleting` | *Literal[True]* | ✅ | N/A | \ No newline at end of file +| `deleting` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/deleteobservabilitydestinationresponse.mdx b/docs/components/deleteobservabilitydestinationresponse.mdx index 8660679b1..4d572b688 100644 --- a/docs/components/deleteobservabilitydestinationresponse.mdx +++ b/docs/components/deleteobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteObservabilityDestinationResponse" | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `deleted` | *Literal[True]* | ✅ | Always `true` on success. | \ No newline at end of file +| `deleted` | *Literal[True]* | :heavy_check_mark: | Always `true` on success. | \ No newline at end of file diff --git a/docs/components/deleteprivateendpointresponse.mdx b/docs/components/deleteprivateendpointresponse.mdx index 039a2200f..d4e2b8816 100644 --- a/docs/components/deleteprivateendpointresponse.mdx +++ b/docs/components/deleteprivateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "DeletePrivateEndpointResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | [components.DeletePrivateEndpointResponseData](../components/deleteprivateendpointresponsedata.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.DeletePrivateEndpointResponseData](../components/deleteprivateendpointresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/deleteprivateendpointresponsedata.mdx b/docs/components/deleteprivateendpointresponsedata.mdx index 83b946878..bdef67898 100644 --- a/docs/components/deleteprivateendpointresponsedata.mdx +++ b/docs/components/deleteprivateendpointresponsedata.mdx @@ -6,4 +6,4 @@ title: "DeletePrivateEndpointResponseData" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/components/deletescimgroupmappingresponse.mdx b/docs/components/deletescimgroupmappingresponse.mdx index 593f90002..1ed4e164a 100644 --- a/docs/components/deletescimgroupmappingresponse.mdx +++ b/docs/components/deletescimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteScimGroupMappingResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `deleted` | *Literal[True]* | ✅ | N/A | \ No newline at end of file +| `deleted` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/deleteworkspacebudgetresponse.mdx b/docs/components/deleteworkspacebudgetresponse.mdx index 35ef08759..fb5ff101e 100644 --- a/docs/components/deleteworkspacebudgetresponse.mdx +++ b/docs/components/deleteworkspacebudgetresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `deleted` | *Literal[True]* | ✅ | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file +| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file diff --git a/docs/components/deleteworkspaceresponse.mdx b/docs/components/deleteworkspaceresponse.mdx index d5a14f3ab..93b4da474 100644 --- a/docs/components/deleteworkspaceresponse.mdx +++ b/docs/components/deleteworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteWorkspaceResponse" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *Literal[True]* | ✅ | Confirmation that the workspace was deleted | true | \ No newline at end of file +| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the workspace was deleted | true | \ No newline at end of file diff --git a/docs/components/easyinputmessage.mdx b/docs/components/easyinputmessage.mdx index baadd1cbd..60e935b6d 100644 --- a/docs/components/easyinputmessage.mdx +++ b/docs/components/easyinputmessage.mdx @@ -6,7 +6,7 @@ title: "EasyInputMessage" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [OptionalNullable[components.EasyInputMessageContentUnion2]](../components/easyinputmessagecontentunion2.mdx) | ➖ | N/A | | -| `phase` | [OptionalNullable[components.EasyInputMessagePhaseUnion]](../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](../components/easyinputmessageroleunion.mdx) | ✅ | N/A | | -| `type` | [Optional[components.EasyInputMessageTypeMessage]](../components/easyinputmessagetypemessage.mdx) | ➖ | N/A | | \ No newline at end of file +| `content` | [OptionalNullable[components.EasyInputMessageContentUnion2]](../components/easyinputmessagecontentunion2.mdx) | :heavy_minus_sign: | N/A | | +| `phase` | [OptionalNullable[components.EasyInputMessagePhaseUnion]](../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](../components/easyinputmessageroleunion.mdx) | :heavy_check_mark: | N/A | | +| `type` | [Optional[components.EasyInputMessageTypeMessage]](../components/easyinputmessagetypemessage.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/easyinputmessagecontentinputimage.mdx b/docs/components/easyinputmessagecontentinputimage.mdx index fc482ec28..d67f17f84 100644 --- a/docs/components/easyinputmessagecontentinputimage.mdx +++ b/docs/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](../components/easyinputmessagedetail.mdx) | ✅ | N/A | -| `file_id` | *OptionalNullable[str]* | ➖ | N/A | -| `image_url` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.EasyInputMessageTypeInputImage](../components/easyinputmessagetypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file +| `detail` | [components.EasyInputMessageDetail](../components/easyinputmessagedetail.mdx) | :heavy_check_mark: | N/A | +| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.EasyInputMessageTypeInputImage](../components/easyinputmessagetypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/edgenetworktimeoutresponseerrordata.mdx b/docs/components/edgenetworktimeoutresponseerrordata.mdx index a0f6caf35..e0fedd8b5 100644 --- a/docs/components/edgenetworktimeoutresponseerrordata.mdx +++ b/docs/components/edgenetworktimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for EdgeNetworkTimeoutResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/editclearthinking20251015.mdx b/docs/components/editclearthinking20251015.mdx index aa3ec8f3c..0796f7cdb 100644 --- a/docs/components/editclearthinking20251015.mdx +++ b/docs/components/editclearthinking20251015.mdx @@ -6,5 +6,5 @@ title: "EditClearThinking20251015" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `keep` | [Optional[components.Keep]](../components/keep.mdx) | ➖ | N/A | -| `type` | [components.TypeClearThinking20251015](../components/typeclearthinking20251015.mdx) | ✅ | N/A | \ No newline at end of file +| `keep` | [Optional[components.Keep]](../components/keep.mdx) | :heavy_minus_sign: | N/A | +| `type` | [components.TypeClearThinking20251015](../components/typeclearthinking20251015.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/editcleartooluses20250919.mdx b/docs/components/editcleartooluses20250919.mdx index 50fc0a873..a8a31837f 100644 --- a/docs/components/editcleartooluses20250919.mdx +++ b/docs/components/editcleartooluses20250919.mdx @@ -6,9 +6,9 @@ title: "EditClearToolUses20250919" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `clear_at_least` | [OptionalNullable[components.AnthropicInputTokensClearAtLeast]](../components/anthropicinputtokensclearatleast.mdx) | ➖ | N/A | \{
"type": "input_tokens",
"value": 50000
} | -| `clear_tool_inputs` | [OptionalNullable[components.ClearToolInputs]](../components/cleartoolinputs.mdx) | ➖ | N/A | | -| `exclude_tools` | List[*str*] | ➖ | N/A | | -| `keep` | [Optional[components.AnthropicToolUsesKeep]](../components/anthropictooluseskeep.mdx) | ➖ | N/A | \{
"type": "tool_uses",
"value": 5
} | -| `trigger` | [Optional[components.Trigger]](../components/trigger.mdx) | ➖ | N/A | | -| `type` | [components.TypeClearToolUses20250919](../components/typecleartooluses20250919.mdx) | ✅ | N/A | | \ No newline at end of file +| `clear_at_least` | [OptionalNullable[components.AnthropicInputTokensClearAtLeast]](../components/anthropicinputtokensclearatleast.mdx) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 50000
} | +| `clear_tool_inputs` | [OptionalNullable[components.ClearToolInputs]](../components/cleartoolinputs.mdx) | :heavy_minus_sign: | N/A | | +| `exclude_tools` | List[*str*] | :heavy_minus_sign: | N/A | | +| `keep` | [Optional[components.AnthropicToolUsesKeep]](../components/anthropictooluseskeep.mdx) | :heavy_minus_sign: | N/A | \{
"type": "tool_uses",
"value": 5
} | +| `trigger` | [Optional[components.Trigger]](../components/trigger.mdx) | :heavy_minus_sign: | N/A | | +| `type` | [components.TypeClearToolUses20250919](../components/typecleartooluses20250919.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/editcompact20260112.mdx b/docs/components/editcompact20260112.mdx index 15ea940b3..09c8fd6f6 100644 --- a/docs/components/editcompact20260112.mdx +++ b/docs/components/editcompact20260112.mdx @@ -6,7 +6,7 @@ title: "EditCompact20260112" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `instructions` | *OptionalNullable[str]* | ➖ | N/A | | -| `pause_after_compaction` | *Optional[bool]* | ➖ | N/A | | -| `trigger` | [OptionalNullable[components.TriggerInputTokens]](../components/triggerinputtokens.mdx) | ➖ | N/A | \{
"type": "input_tokens",
"value": 100000
} | -| `type` | [components.TypeCompact20260112](../components/typecompact20260112.mdx) | ✅ | N/A | | \ No newline at end of file +| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `pause_after_compaction` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `trigger` | [OptionalNullable[components.TriggerInputTokens]](../components/triggerinputtokens.mdx) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 100000
} | +| `type` | [components.TypeCompact20260112](../components/typecompact20260112.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/embeddings.mdx b/docs/components/embeddings.mdx index 4b945e4db..dafa20864 100644 --- a/docs/components/embeddings.mdx +++ b/docs/components/embeddings.mdx @@ -6,6 +6,6 @@ title: "Embeddings" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/endpointinfo.mdx b/docs/components/endpointinfo.mdx index 8527695fb..e525afd1a 100644 --- a/docs/components/endpointinfo.mdx +++ b/docs/components/endpointinfo.mdx @@ -6,6 +6,6 @@ title: "EndpointInfo" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | ✅ | N/A | -| `provider` | *str* | ✅ | N/A | -| `selected` | *bool* | ✅ | N/A | \ No newline at end of file +| `model` | *str* | :heavy_check_mark: | N/A | +| `provider` | *str* | :heavy_check_mark: | N/A | +| `selected` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/endpointsmetadata.mdx b/docs/components/endpointsmetadata.mdx index a70410e56..4add6ebfc 100644 --- a/docs/components/endpointsmetadata.mdx +++ b/docs/components/endpointsmetadata.mdx @@ -6,5 +6,5 @@ title: "EndpointsMetadata" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `available` | List[[components.EndpointInfo](../components/endpointinfo.mdx)] | ✅ | N/A | -| `total` | *int* | ✅ | N/A | \ No newline at end of file +| `available` | List[[components.EndpointInfo](../components/endpointinfo.mdx)] | :heavy_check_mark: | N/A | +| `total` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/enduser.mdx b/docs/components/enduser.mdx index 0a7c59d64..27621b0e6 100644 --- a/docs/components/enduser.mdx +++ b/docs/components/enduser.mdx @@ -6,7 +6,7 @@ title: "EndUser" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | Registration creation time. | 2026-09-16T12:00:00Z | -| `is_active` | *bool* | ✅ | Whether this registration is active. Not an inference authorization decision. | true | -| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | -| `user` | *str* | ✅ | 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 +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Registration creation time. | 2026-09-16T12:00:00Z | +| `is_active` | *bool* | :heavy_check_mark: | Whether this registration is active. Not an inference authorization decision. | true | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | +| `user` | *str* | :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/components/enduserresponse.mdx b/docs/components/enduserresponse.mdx index 027565ed6..4b605db12 100644 --- a/docs/components/enduserresponse.mdx +++ b/docs/components/enduserresponse.mdx @@ -6,4 +6,4 @@ title: "EndUserResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.EndUser](../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](../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/components/enumcapability.mdx b/docs/components/enumcapability.mdx index 1aa68f8cf..4c04e707a 100644 --- a/docs/components/enumcapability.mdx +++ b/docs/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](../components/enumcapabilitytype.mdx) | ✅ | N/A | -| `values` | List[*str*] | ✅ | N/A | \ No newline at end of file +| `type` | [components.EnumCapabilityType](../components/enumcapabilitytype.mdx) | :heavy_check_mark: | N/A | +| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/errorevent.mdx b/docs/components/errorevent.mdx index 97c8cbced..b09b8411e 100644 --- a/docs/components/errorevent.mdx +++ b/docs/components/errorevent.mdx @@ -9,8 +9,8 @@ Event emitted when an error occurs during streaming | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `code` | *Nullable[str]* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `param` | *Nullable[str]* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ErrorEventType](../components/erroreventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `code` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `param` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ErrorEventType](../components/erroreventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/failedmodel.mdx b/docs/components/failedmodel.mdx index cde817d52..70d6de50d 100644 --- a/docs/components/failedmodel.mdx +++ b/docs/components/failedmodel.mdx @@ -6,6 +6,6 @@ title: "FailedModel" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `error` | *str* | ✅ | Error message describing why the model failed. | -| `model` | *str* | ✅ | Slug of the analysis model that failed. | -| `status_code` | *Optional[int]* | ➖ | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file +| `error` | *str* | :heavy_check_mark: | Error message describing why the model failed. | +| `model` | *str* | :heavy_check_mark: | Slug of the analysis model that failed. | +| `status_code` | *Optional[int]* | :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/components/filecitation.mdx b/docs/components/filecitation.mdx index c0d119341..79ca74388 100644 --- a/docs/components/filecitation.mdx +++ b/docs/components/filecitation.mdx @@ -6,7 +6,7 @@ title: "FileCitation" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `file_id` | *str* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `index` | *int* | ✅ | N/A | -| `type` | [components.FileCitationType](../components/filecitationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FileCitationType](../components/filecitationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fileparserplugin.mdx b/docs/components/fileparserplugin.mdx index d4d529094..2a74948b2 100644 --- a/docs/components/fileparserplugin.mdx +++ b/docs/components/fileparserplugin.mdx @@ -6,6 +6,6 @@ title: "FileParserPlugin" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | ➖ | Set to false to disable the file-parser plugin for this request. Defaults to true. | | -| `id` | [components.FileParserPluginID](../components/fileparserpluginid.mdx) | ✅ | N/A | | -| `pdf` | [Optional[components.PDFParserOptions]](../components/pdfparseroptions.mdx) | ➖ | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file +| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | | +| `id` | [components.FileParserPluginID](../components/fileparserpluginid.mdx) | :heavy_check_mark: | N/A | | +| `pdf` | [Optional[components.PDFParserOptions]](../components/pdfparseroptions.mdx) | :heavy_minus_sign: | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file diff --git a/docs/components/filepath.mdx b/docs/components/filepath.mdx index 2cdf20979..f6d81e7b4 100644 --- a/docs/components/filepath.mdx +++ b/docs/components/filepath.mdx @@ -6,6 +6,6 @@ title: "FilePath" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `file_id` | *str* | ✅ | N/A | -| `index` | *int* | ✅ | N/A | -| `type` | [components.FilePathType](../components/filepathtype.mdx) | ✅ | N/A | \ No newline at end of file +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FilePathType](../components/filepathtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/filesearchservertool.mdx b/docs/components/filesearchservertool.mdx index d1b6b622c..573425f38 100644 --- a/docs/components/filesearchservertool.mdx +++ b/docs/components/filesearchservertool.mdx @@ -9,8 +9,8 @@ File search tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `filters` | [OptionalNullable[components.FiltersUnion]](../components/filtersunion.mdx) | ➖ | N/A | -| `max_num_results` | *Optional[int]* | ➖ | N/A | -| `ranking_options` | [Optional[components.RankingOptions]](../components/rankingoptions.mdx) | ➖ | N/A | -| `type` | [components.TypeFileSearch](../components/typefilesearch.mdx) | ✅ | N/A | -| `vector_store_ids` | List[*str*] | ✅ | N/A | \ No newline at end of file +| `filters` | [OptionalNullable[components.FiltersUnion]](../components/filtersunion.mdx) | :heavy_minus_sign: | N/A | +| `max_num_results` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `ranking_options` | [Optional[components.RankingOptions]](../components/rankingoptions.mdx) | :heavy_minus_sign: | N/A | +| `type` | [components.TypeFileSearch](../components/typefilesearch.mdx) | :heavy_check_mark: | N/A | +| `vector_store_ids` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/filesservertool.mdx b/docs/components/filesservertool.mdx index 7c4b21c01..d9cc0a84d 100644 --- a/docs/components/filesservertool.mdx +++ b/docs/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` | [Optional[components.FilesServerToolConfig]](../components/filesservertoolconfig.mdx) | ➖ | Configuration for the openrouter:files server tool | \{} | -| `type` | [components.FilesServerToolType](../components/filesservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.FilesServerToolConfig]](../components/filesservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:files server tool | \{} | +| `type` | [components.FilesServerToolType](../components/filesservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/filters.mdx b/docs/components/filters.mdx index 8620174c3..deb052770 100644 --- a/docs/components/filters.mdx +++ b/docs/components/filters.mdx @@ -6,6 +6,6 @@ title: "Filters" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `key` | *str* | ✅ | N/A | -| `type` | [components.FiltersType](../components/filterstype.mdx) | ✅ | N/A | -| `value` | [components.FileSearchServerToolValue2](../components/filesearchservertoolvalue2.mdx) | ✅ | N/A | \ No newline at end of file +| `key` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.FiltersType](../components/filterstype.mdx) | :heavy_check_mark: | N/A | +| `value` | [components.FileSearchServerToolValue2](../components/filesearchservertoolvalue2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/forbiddenresponseerrordata.mdx b/docs/components/forbiddenresponseerrordata.mdx index 2f07b6e1d..cdc5cd4c3 100644 --- a/docs/components/forbiddenresponseerrordata.mdx +++ b/docs/components/forbiddenresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ForbiddenResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/formatgrammar.mdx b/docs/components/formatgrammar.mdx index 6a72260c4..27fb6f5f6 100644 --- a/docs/components/formatgrammar.mdx +++ b/docs/components/formatgrammar.mdx @@ -6,6 +6,6 @@ title: "FormatGrammar" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `definition` | *str* | ✅ | N/A | -| `syntax` | [components.Syntax](../components/syntax.mdx) | ✅ | N/A | -| `type` | [components.FormatTypeGrammar](../components/formattypegrammar.mdx) | ✅ | N/A | \ No newline at end of file +| `definition` | *str* | :heavy_check_mark: | N/A | +| `syntax` | [components.Syntax](../components/syntax.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.FormatTypeGrammar](../components/formattypegrammar.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/formatjsonobjectconfig.mdx b/docs/components/formatjsonobjectconfig.mdx index 6574b722b..376faaf43 100644 --- a/docs/components/formatjsonobjectconfig.mdx +++ b/docs/components/formatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.FormatJSONObjectConfigType](../components/formatjsonobjectconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.FormatJSONObjectConfigType](../components/formatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/formatjsonschemaconfig.mdx b/docs/components/formatjsonschemaconfig.mdx index 41ed4000f..0ddb8ed41 100644 --- a/docs/components/formatjsonschemaconfig.mdx +++ b/docs/components/formatjsonschemaconfig.mdx @@ -9,8 +9,8 @@ JSON schema constrained response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `description` | *Optional[str]* | ➖ | N/A | -| `name` | *str* | ✅ | N/A | -| `schema_` | Dict[str, *Any*] | ✅ | N/A | -| `strict` | *OptionalNullable[bool]* | ➖ | N/A | -| `type` | [components.FormatJSONSchemaConfigType](../components/formatjsonschemaconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `schema_` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | +| `type` | [components.FormatJSONSchemaConfigType](../components/formatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/formattext.mdx b/docs/components/formattext.mdx index 5f8a4a169..61d6f3b9e 100644 --- a/docs/components/formattext.mdx +++ b/docs/components/formattext.mdx @@ -6,4 +6,4 @@ title: "FormatText" | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `type` | [components.FormatTypeText](../components/formattypetext.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.FormatTypeText](../components/formattypetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/formattextconfig.mdx b/docs/components/formattextconfig.mdx index 2bb064f9f..798671326 100644 --- a/docs/components/formattextconfig.mdx +++ b/docs/components/formattextconfig.mdx @@ -9,4 +9,4 @@ Plain text response format | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [components.FormatTextConfigType](../components/formattextconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.FormatTextConfigType](../components/formattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/frameimage.mdx b/docs/components/frameimage.mdx index a2e39e876..46b4b985d 100644 --- a/docs/components/frameimage.mdx +++ b/docs/components/frameimage.mdx @@ -6,6 +6,6 @@ title: "FrameImage" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `image_url` | [components.FrameImageImageURL](../components/frameimageimageurl.mdx) | ✅ | N/A | | -| `type` | [components.FrameImageType](../components/frameimagetype.mdx) | ✅ | N/A | | -| `frame_type` | [components.FrameType](../components/frametype.mdx) | ✅ | Whether this image represents the first or last frame of the video | first_frame | \ No newline at end of file +| `image_url` | [components.FrameImageImageURL](../components/frameimageimageurl.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.FrameImageType](../components/frameimagetype.mdx) | :heavy_check_mark: | N/A | | +| `frame_type` | [components.FrameType](../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/components/frameimageimageurl.mdx b/docs/components/frameimageimageurl.mdx index ad4a7de2b..713a81f1d 100644 --- a/docs/components/frameimageimageurl.mdx +++ b/docs/components/frameimageimageurl.mdx @@ -6,4 +6,4 @@ title: "FrameImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/freemodeldailyrequests.mdx b/docs/components/freemodeldailyrequests.mdx index 4bf505f25..b0a9f40d0 100644 --- a/docs/components/freemodeldailyrequests.mdx +++ b/docs/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` | *int* | ✅ | 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` | *int* | ✅ | Free-model requests left in the current UTC day | 38 | -| `used` | *int* | ✅ | Free-model requests recorded for the account so far in the current UTC day | 12 | \ No newline at end of file +| `limit` | *int* | :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` | *int* | :heavy_check_mark: | Free-model requests left in the current UTC day | 38 | +| `used` | *int* | :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/components/functioncallargsdeltaevent.mdx b/docs/components/functioncallargsdeltaevent.mdx index d6b954b7a..e28936eff 100644 --- a/docs/components/functioncallargsdeltaevent.mdx +++ b/docs/components/functioncallargsdeltaevent.mdx @@ -9,8 +9,8 @@ Event emitted when function call arguments are being streamed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `delta` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.FunctionCallArgsDeltaEventType](../components/functioncallargsdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FunctionCallArgsDeltaEventType](../components/functioncallargsdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/functioncallargsdoneevent.mdx b/docs/components/functioncallargsdoneevent.mdx index b2b5fb080..acc25e399 100644 --- a/docs/components/functioncallargsdoneevent.mdx +++ b/docs/components/functioncallargsdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when function call arguments streaming is complete | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `arguments` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `name` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.FunctionCallArgsDoneEventType](../components/functioncallargsdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FunctionCallArgsDoneEventType](../components/functioncallargsdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/functioncallitem.mdx b/docs/components/functioncallitem.mdx index 837846826..9d430414f 100644 --- a/docs/components/functioncallitem.mdx +++ b/docs/components/functioncallitem.mdx @@ -9,13 +9,13 @@ A function call initiated by the model | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | ✅ | N/A | | -| `async_` | *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 | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `namespace` | *OptionalNullable[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | -| `subagent_id` | *OptionalNullable[str]* | ➖ | 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. | | -| `subagent_items` | List[[components.FunctionCallItemSubagentItem](../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](../components/functioncallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | | +| `async_` | *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 | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `namespace` | *OptionalNullable[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | +| `subagent_id` | *OptionalNullable[str]* | :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. | | +| `subagent_items` | List[[components.FunctionCallItemSubagentItem](../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](../components/functioncallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/functioncallitemsubagentitem.mdx b/docs/components/functioncallitemsubagentitem.mdx index d77ed7b26..19df504a4 100644 --- a/docs/components/functioncallitemsubagentitem.mdx +++ b/docs/components/functioncallitemsubagentitem.mdx @@ -6,5 +6,5 @@ title: "FunctionCallItemSubagentItem" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `type` | *str* | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/functioncalloutputitem.mdx b/docs/components/functioncalloutputitem.mdx index f235332ab..f0bca51ca 100644 --- a/docs/components/functioncalloutputitem.mdx +++ b/docs/components/functioncalloutputitem.mdx @@ -9,8 +9,8 @@ The output from a function call execution | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `output` | [components.FunctionCallOutputItemOutputUnion2](../components/functioncalloutputitemoutputunion2.mdx) | ✅ | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | -| `type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../components/functioncalloutputitemtypefunctioncalloutput.mdx) | ✅ | N/A | | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `output` | [components.FunctionCallOutputItemOutputUnion2](../components/functioncalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | +| `type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../components/functioncalloutputitemtypefunctioncalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/functioncalloutputitemoutputinputimage.mdx b/docs/components/functioncalloutputitemoutputinputimage.mdx index 10d15d89a..245498dc2 100644 --- a/docs/components/functioncalloutputitemoutputinputimage.mdx +++ b/docs/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](../components/functioncalloutputitemdetail.mdx) | ✅ | N/A | -| `file_id` | *OptionalNullable[str]* | ➖ | N/A | -| `image_url` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.FunctionCallOutputItemOutputType](../components/functioncalloutputitemoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `detail` | [components.FunctionCallOutputItemDetail](../components/functioncalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | +| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.FunctionCallOutputItemOutputType](../components/functioncalloutputitemoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusionanalysisresult.mdx b/docs/components/fusionanalysisresult.mdx index 08fcee4ac..06562dd23 100644 --- a/docs/components/fusionanalysisresult.mdx +++ b/docs/components/fusionanalysisresult.mdx @@ -9,8 +9,8 @@ Structured analysis produced by the fusion analyst model. | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `blind_spots` | List[*str*] | ✅ | N/A | -| `consensus` | List[*str*] | ✅ | N/A | -| `contradictions` | List[[components.Contradiction](../components/contradiction.mdx)] | ✅ | N/A | -| `partial_coverage` | List[[components.PartialCoverage](../components/partialcoverage.mdx)] | ✅ | N/A | -| `unique_insights` | List[[components.UniqueInsight](../components/uniqueinsight.mdx)] | ✅ | N/A | \ No newline at end of file +| `blind_spots` | List[*str*] | :heavy_check_mark: | N/A | +| `consensus` | List[*str*] | :heavy_check_mark: | N/A | +| `contradictions` | List[[components.Contradiction](../components/contradiction.mdx)] | :heavy_check_mark: | N/A | +| `partial_coverage` | List[[components.PartialCoverage](../components/partialcoverage.mdx)] | :heavy_check_mark: | N/A | +| `unique_insights` | List[[components.UniqueInsight](../components/uniqueinsight.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallanalysiscompletedevent.mdx b/docs/components/fusioncallanalysiscompletedevent.mdx index 4ac75319b..7f295a8c0 100644 --- a/docs/components/fusioncallanalysiscompletedevent.mdx +++ b/docs/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](../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"
}
]
} | -| `item_id` | *str* | ✅ | N/A | | -| `output_index` | *int* | ✅ | N/A | | -| `sequence_number` | *int* | ✅ | N/A | | -| `type` | [components.FusionCallAnalysisCompletedEventType](../components/fusioncallanalysiscompletedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `analysis` | [components.FusionAnalysisResult](../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"
}
]
} | +| `item_id` | *str* | :heavy_check_mark: | N/A | | +| `output_index` | *int* | :heavy_check_mark: | N/A | | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.FusionCallAnalysisCompletedEventType](../components/fusioncallanalysiscompletedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/fusioncallanalysisinprogressevent.mdx b/docs/components/fusioncallanalysisinprogressevent.mdx index 278c9a226..6538c8ffb 100644 --- a/docs/components/fusioncallanalysisinprogressevent.mdx +++ b/docs/components/fusioncallanalysisinprogressevent.mdx @@ -9,9 +9,9 @@ Emitted when the fusion analyst starts producing the structured analysis. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analyst_model` | *str* | ✅ | Slug of the model producing the structured analysis. | -| `item_id` | *str* | ✅ | N/A | -| ~~`judge_model`~~ | *str* | ✅ | : 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`. | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.FusionCallAnalysisInProgressEventType](../components/fusioncallanalysisinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `analyst_model` | *str* | :heavy_check_mark: | Slug of the model producing the structured analysis. | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| ~~`judge_model`~~ | *str* | :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`. | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FusionCallAnalysisInProgressEventType](../components/fusioncallanalysisinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallcompletedevent.mdx b/docs/components/fusioncallcompletedevent.mdx index 0a972dfff..400524487 100644 --- a/docs/components/fusioncallcompletedevent.mdx +++ b/docs/components/fusioncallcompletedevent.mdx @@ -9,7 +9,7 @@ Emitted when the openrouter:fusion tool call finishes. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.FusionCallCompletedEventType](../components/fusioncallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FusionCallCompletedEventType](../components/fusioncallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallinprogressevent.mdx b/docs/components/fusioncallinprogressevent.mdx index b894d5b3b..8f27a2d07 100644 --- a/docs/components/fusioncallinprogressevent.mdx +++ b/docs/components/fusioncallinprogressevent.mdx @@ -9,7 +9,7 @@ Emitted when an openrouter:fusion tool call begins executing. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.FusionCallInProgressEventType](../components/fusioncallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FusionCallInProgressEventType](../components/fusioncallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpaneladdedevent.mdx b/docs/components/fusioncallpaneladdedevent.mdx index 3b71a029c..260884b7d 100644 --- a/docs/components/fusioncallpaneladdedevent.mdx +++ b/docs/components/fusioncallpaneladdedevent.mdx @@ -9,8 +9,8 @@ Emitted when a fusion analysis-panel model starts. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `item_id` | *str* | ✅ | N/A | -| `model` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.FusionCallPanelAddedEventType](../components/fusioncallpaneladdedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FusionCallPanelAddedEventType](../components/fusioncallpaneladdedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpanelcompletedevent.mdx b/docs/components/fusioncallpanelcompletedevent.mdx index bb91231b1..1d115a6af 100644 --- a/docs/components/fusioncallpanelcompletedevent.mdx +++ b/docs/components/fusioncallpanelcompletedevent.mdx @@ -9,9 +9,9 @@ Emitted when a fusion panel model finishes with its full content. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `content` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `model` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.FusionCallPanelCompletedEventType](../components/fusioncallpanelcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FusionCallPanelCompletedEventType](../components/fusioncallpanelcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpaneldeltaevent.mdx b/docs/components/fusioncallpaneldeltaevent.mdx index a87bd9640..3f8a569b7 100644 --- a/docs/components/fusioncallpaneldeltaevent.mdx +++ b/docs/components/fusioncallpaneldeltaevent.mdx @@ -9,9 +9,9 @@ Incremental content token from a fusion panel model. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `delta` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `model` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.FusionCallPanelDeltaEventType](../components/fusioncallpaneldeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FusionCallPanelDeltaEventType](../components/fusioncallpaneldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpanelfailedevent.mdx b/docs/components/fusioncallpanelfailedevent.mdx index 8a52799f0..a6c9fa535 100644 --- a/docs/components/fusioncallpanelfailedevent.mdx +++ b/docs/components/fusioncallpanelfailedevent.mdx @@ -9,10 +9,10 @@ Emitted when a fusion panel model fails. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `error` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `model` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `status_code` | *Optional[int]* | ➖ | N/A | -| `type` | [components.FusionCallPanelFailedEventType](../components/fusioncallpanelfailedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `error` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `status_code` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `type` | [components.FusionCallPanelFailedEventType](../components/fusioncallpanelfailedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpanelreasoningdeltaevent.mdx b/docs/components/fusioncallpanelreasoningdeltaevent.mdx index fc6d5fcbc..a25d4c0eb 100644 --- a/docs/components/fusioncallpanelreasoningdeltaevent.mdx +++ b/docs/components/fusioncallpanelreasoningdeltaevent.mdx @@ -9,9 +9,9 @@ Incremental reasoning token from a fusion panel model. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `delta` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `model` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.FusionCallPanelReasoningDeltaEventType](../components/fusioncallpanelreasoningdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.FusionCallPanelReasoningDeltaEventType](../components/fusioncallpanelreasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/fusionplugin.mdx b/docs/components/fusionplugin.mdx index bf9895e5d..b9dcf8463 100644 --- a/docs/components/fusionplugin.mdx +++ b/docs/components/fusionplugin.mdx @@ -6,10 +6,10 @@ title: "FusionPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis_models` | List[*str*] | ➖ | 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` | *Optional[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](../components/fusionpluginid.mdx) | ✅ | N/A | | -| `max_tool_calls` | *Optional[int]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.PresetEnum]](../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` | List[[components.FusionPluginTool](../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 +| `analysis_models` | List[*str*] | :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` | *Optional[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](../components/fusionpluginid.mdx) | :heavy_check_mark: | N/A | | +| `max_tool_calls` | *Optional[int]* | :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` | *Optional[str]* | :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` | [Optional[components.PresetEnum]](../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` | List[[components.FusionPluginTool](../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/components/fusionplugintool.mdx b/docs/components/fusionplugintool.mdx index 32726e1c2..967c0e2ab 100644 --- a/docs/components/fusionplugintool.mdx +++ b/docs/components/fusionplugintool.mdx @@ -6,5 +6,5 @@ title: "FusionPluginTool" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `parameters` | Dict[str, [Nullable[components.Parameters3]](../components/parameters3.mdx)] | ➖ | Optional configuration forwarded as the tool's `parameters` object. | -| `type` | *str* | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `parameters` | Dict[str, [Nullable[components.Parameters3]](../components/parameters3.mdx)] | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | +| `type` | *str* | :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/components/fusionservertoolconfig.mdx b/docs/components/fusionservertoolconfig.mdx index 10947deb9..2c2377326 100644 --- a/docs/components/fusionservertoolconfig.mdx +++ b/docs/components/fusionservertoolconfig.mdx @@ -9,11 +9,11 @@ Configuration for the openrouter:fusion server tool. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `analysis_models` | List[*str*] | ➖ | 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"
] | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `max_completion_tokens` | *Optional[int]* | ➖ | 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 | -| `max_tool_calls` | *Optional[int]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.FusionServerToolConfigReasoning]](../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` | *Optional[float]* | ➖ | 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` | List[[components.FusionServerToolConfigTool](../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 +| `analysis_models` | List[*str*] | :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"
] | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `max_completion_tokens` | *Optional[int]* | :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 | +| `max_tool_calls` | *Optional[int]* | :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` | *Optional[str]* | :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` | [Optional[components.FusionServerToolConfigReasoning]](../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` | *Optional[float]* | :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` | List[[components.FusionServerToolConfigTool](../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/components/fusionservertoolconfigreasoning.mdx b/docs/components/fusionservertoolconfigreasoning.mdx index 5114e6e20..49dd617c5 100644 --- a/docs/components/fusionservertoolconfigreasoning.mdx +++ b/docs/components/fusionservertoolconfigreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to panelist and analyst inner calls. Use this | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `effort` | [Optional[components.FusionServerToolConfigEffort]](../components/fusionservertoolconfigeffort.mdx) | ➖ | Reasoning effort level for panelist and analyst inner calls. | -| `max_tokens` | *Optional[int]* | ➖ | 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` | [Optional[components.FusionServerToolConfigEffort]](../components/fusionservertoolconfigeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for panelist and analyst inner calls. | +| `max_tokens` | *Optional[int]* | :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/components/fusionservertoolconfigtool.mdx b/docs/components/fusionservertoolconfigtool.mdx index 6ed3cd6d3..486dbbd1c 100644 --- a/docs/components/fusionservertoolconfigtool.mdx +++ b/docs/components/fusionservertoolconfigtool.mdx @@ -6,5 +6,5 @@ title: "FusionServerToolConfigTool" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `parameters` | Dict[str, *Any*] | ➖ | Optional configuration forwarded as the tool's `parameters` object. | -| `type` | *str* | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | +| `type` | *str* | :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/components/fusionservertoolopenrouter.mdx b/docs/components/fusionservertoolopenrouter.mdx index 35ffa1c43..43417bf5d 100644 --- a/docs/components/fusionservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.FusionServerToolConfig]](../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](../components/fusionservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.FusionServerToolConfig]](../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](../components/fusionservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/fusionsource.mdx b/docs/components/fusionsource.mdx index 24dcdfc2c..384c9eac3 100644 --- a/docs/components/fusionsource.mdx +++ b/docs/components/fusionsource.mdx @@ -9,5 +9,5 @@ A web page retrieved via web search during a fusion run. | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `title` | *str* | ✅ | Title of the retrieved web page. | -| `url` | *str* | ✅ | URL of the web page a panel or the analyst retrieved during the run. | \ No newline at end of file +| `title` | *str* | :heavy_check_mark: | Title of the retrieved web page. | +| `url` | *str* | :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/components/gatewaytimeoutresponseerrordata.mdx b/docs/components/gatewaytimeoutresponseerrordata.mdx index 10d800ea2..281176afa 100644 --- a/docs/components/gatewaytimeoutresponseerrordata.mdx +++ b/docs/components/gatewaytimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for GatewayTimeoutResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/generationcontentdata.mdx b/docs/components/generationcontentdata.mdx index ebd235b37..09bc28302 100644 --- a/docs/components/generationcontentdata.mdx +++ b/docs/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` | [Nullable[components.GenerationContentError]](../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](../components/inputunion.mdx) | ✅ | The input to the generation — either a prompt string or an array of messages | | -| `output` | [components.GenerationContentDataOutput](../components/generationcontentdataoutput.mdx) | ✅ | The output from the generation | | \ No newline at end of file +| `error` | [Nullable[components.GenerationContentError]](../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](../components/inputunion.mdx) | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | | +| `output` | [components.GenerationContentDataOutput](../components/generationcontentdataoutput.mdx) | :heavy_check_mark: | The output from the generation | | \ No newline at end of file diff --git a/docs/components/generationcontentdataoutput.mdx b/docs/components/generationcontentdataoutput.mdx index d5b7664a7..d497eb12b 100644 --- a/docs/components/generationcontentdataoutput.mdx +++ b/docs/components/generationcontentdataoutput.mdx @@ -9,5 +9,5 @@ The output from the generation | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `completion` | *Nullable[str]* | ✅ | The completion output | The meaning of life is a philosophical question... | -| `reasoning` | *Nullable[str]* | ✅ | Reasoning/thinking output, if any | null | \ No newline at end of file +| `completion` | *Nullable[str]* | :heavy_check_mark: | The completion output | The meaning of life is a philosophical question... | +| `reasoning` | *Nullable[str]* | :heavy_check_mark: | Reasoning/thinking output, if any | null | \ No newline at end of file diff --git a/docs/components/generationcontenterror.mdx b/docs/components/generationcontenterror.mdx index 800c71fa5..f6cee61d8 100644 --- a/docs/components/generationcontenterror.mdx +++ b/docs/components/generationcontenterror.mdx @@ -9,8 +9,8 @@ The stored failure for this generation, or null when it succeeded | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `message` | *Nullable[str]* | ✅ | Error message returned to the client | Timed out waiting for the provider | -| `previous_errors` | List[[components.GenerationContentErrorAttempt](../components/generationcontenterrorattempt.mdx)] | ✅ | Every upstream attempt that failed before the returned error, in attempt order | | -| `provider_name` | *Nullable[str]* | ✅ | Provider whose error was returned to the client, when known | Vertex | -| `raw` | *Nullable[str]* | ✅ | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | -| `status` | *Nullable[int]* | ✅ | HTTP status returned to the client | 504 | \ No newline at end of file +| `message` | *Nullable[str]* | :heavy_check_mark: | Error message returned to the client | Timed out waiting for the provider | +| `previous_errors` | List[[components.GenerationContentErrorAttempt](../components/generationcontenterrorattempt.mdx)] | :heavy_check_mark: | Every upstream attempt that failed before the returned error, in attempt order | | +| `provider_name` | *Nullable[str]* | :heavy_check_mark: | Provider whose error was returned to the client, when known | Vertex | +| `raw` | *Nullable[str]* | :heavy_check_mark: | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | +| `status` | *Nullable[int]* | :heavy_check_mark: | HTTP status returned to the client | 504 | \ No newline at end of file diff --git a/docs/components/generationcontenterrorattempt.mdx b/docs/components/generationcontenterrorattempt.mdx index c1f8cf89f..cc7ba02b5 100644 --- a/docs/components/generationcontenterrorattempt.mdx +++ b/docs/components/generationcontenterrorattempt.mdx @@ -9,7 +9,7 @@ A single failed upstream attempt recorded for the generation | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `code` | *int* | ✅ | HTTP status returned by this attempt | 429 | -| `message` | *str* | ✅ | Error message returned by this attempt | Provider returned error | -| `provider_name` | *Nullable[str]* | ✅ | Provider that served this attempt, when known | Google | -| `raw` | *Nullable[str]* | ✅ | Raw error body returned by the provider, when stored | \{"error":\{"code":429,"message":"Resource exhausted"}} | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | HTTP status returned by this attempt | 429 | +| `message` | *str* | :heavy_check_mark: | Error message returned by this attempt | Provider returned error | +| `provider_name` | *Nullable[str]* | :heavy_check_mark: | Provider that served this attempt, when known | Google | +| `raw` | *Nullable[str]* | :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/components/generationcontentresponse.mdx b/docs/components/generationcontentresponse.mdx index e561545c9..8fab8bcf0 100644 --- a/docs/components/generationcontentresponse.mdx +++ b/docs/components/generationcontentresponse.mdx @@ -9,4 +9,4 @@ Stored prompt and completion content for a generation | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.GenerationContentData](../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](../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/components/generationresponse.mdx b/docs/components/generationresponse.mdx index bf438056d..b876dce8c 100644 --- a/docs/components/generationresponse.mdx +++ b/docs/components/generationresponse.mdx @@ -9,4 +9,4 @@ Generation response | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `data` | [components.GenerationResponseData](../components/generationresponsedata.mdx) | ✅ | Generation data | \ No newline at end of file +| `data` | [components.GenerationResponseData](../components/generationresponsedata.mdx) | :heavy_check_mark: | Generation data | \ No newline at end of file diff --git a/docs/components/generationresponsedata.mdx b/docs/components/generationresponsedata.mdx index 942588a0b..bf175271c 100644 --- a/docs/components/generationresponsedata.mdx +++ b/docs/components/generationresponsedata.mdx @@ -9,48 +9,48 @@ Generation data | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_type` | [Nullable[components.APIType]](../components/apitype.mdx) | ✅ | Type of API used for the generation | | -| `app_id` | *Nullable[int]* | ✅ | ID of the app that made the request | 12345 | -| `cache_discount` | *Nullable[float]* | ✅ | Discount applied due to caching | 0.0002 | -| `cancelled` | *Nullable[bool]* | ✅ | Whether the generation was cancelled | false | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `data_region` | [components.GenerationResponseDataRegion](../components/generationresponsedataregion.mdx) | ✅ | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | -| `external_user` | *Nullable[str]* | ✅ | External user identifier | user-123 | -| `finish_reason` | *Nullable[str]* | ✅ | Reason the generation finished | stop | -| `generation_time` | *Nullable[float]* | ✅ | Time taken for generation in milliseconds | 1200 | -| `http_referer` | *Nullable[str]* | ✅ | Referer header from the request | | -| `id` | *str* | ✅ | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `is_byok` | *bool* | ✅ | Whether this used bring-your-own-key | false | -| `latency` | *Nullable[float]* | ✅ | Total latency in milliseconds | 1250 | -| `model` | *str* | ✅ | Model used for the generation | sao10k/l3-stheno-8b | -| `moderation_latency` | *Nullable[float]* | ✅ | Moderation latency in milliseconds | 50 | -| `native_finish_reason` | *Nullable[str]* | ✅ | Native finish reason as reported by provider | stop | -| `native_tokens_cached` | *Nullable[int]* | ✅ | Native cached tokens as reported by provider | 3 | -| `native_tokens_completion` | *Nullable[int]* | ✅ | Native completion tokens as reported by provider | 25 | -| `native_tokens_completion_images` | *Nullable[int]* | ✅ | Native completion image tokens as reported by provider | 0 | -| `native_tokens_prompt` | *Nullable[int]* | ✅ | Native prompt tokens as reported by provider | 10 | -| `native_tokens_reasoning` | *Nullable[int]* | ✅ | Native reasoning tokens as reported by provider | 5 | -| `num_fetches` | *Nullable[int]* | ✅ | Number of web fetches performed | 0 | -| `num_input_audio_prompt` | *Nullable[int]* | ✅ | Number of audio inputs in the prompt | 0 | -| `num_media_completion` | *Nullable[int]* | ✅ | Number of media items in the completion | 0 | -| `num_media_prompt` | *Nullable[int]* | ✅ | Number of media items in the prompt | 1 | -| `num_search_results` | *Nullable[int]* | ✅ | Number of search results included | 5 | -| `origin` | *str* | ✅ | Origin URL of the request | https://openrouter.ai/ | -| `preset_id` | *Nullable[str]* | ✅ | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | -| `provider_name` | *Nullable[str]* | ✅ | Name of the provider that served the request | Infermatic | -| `provider_responses` | List[[components.ProviderResponse](../components/providerresponse.mdx)] | ✅ | List of provider responses for this generation, including fallback attempts | | -| `request_id` | *OptionalNullable[str]* | ➖ | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | -| `response_cache_source_id` | *OptionalNullable[str]* | ➖ | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | -| `router` | *Nullable[str]* | ✅ | Router used for the request (e.g., openrouter/auto) | openrouter/auto | -| `service_tier` | *Nullable[str]* | ✅ | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | -| `session_id` | *OptionalNullable[str]* | ➖ | Session identifier grouping multiple generations in the same session | | -| `streamed` | *Nullable[bool]* | ✅ | Whether the response was streamed | true | -| `tokens_completion` | *Nullable[int]* | ✅ | Number of tokens in the completion | 25 | -| `tokens_prompt` | *Nullable[int]* | ✅ | Number of tokens in the prompt | 10 | -| `total_cost` | *float* | ✅ | Total cost of the generation in USD | 0.0015 | -| `upstream_id` | *Nullable[str]* | ✅ | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `upstream_inference_cost` | *Nullable[float]* | ✅ | Cost charged by the upstream provider | 0.0012 | -| `usage` | *float* | ✅ | Usage amount in USD | 0.0015 | -| `user_agent` | *Nullable[str]* | ✅ | User-Agent header from the request | | -| `web_search_engine` | *Nullable[str]* | ✅ | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | -| `workspace_id` | *Nullable[str]* | ✅ | 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 +| `api_type` | [Nullable[components.APIType]](../components/apitype.mdx) | :heavy_check_mark: | Type of API used for the generation | | +| `app_id` | *Nullable[int]* | :heavy_check_mark: | ID of the app that made the request | 12345 | +| `cache_discount` | *Nullable[float]* | :heavy_check_mark: | Discount applied due to caching | 0.0002 | +| `cancelled` | *Nullable[bool]* | :heavy_check_mark: | Whether the generation was cancelled | false | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | +| `data_region` | [components.GenerationResponseDataRegion](../components/generationresponsedataregion.mdx) | :heavy_check_mark: | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | +| `external_user` | *Nullable[str]* | :heavy_check_mark: | External user identifier | user-123 | +| `finish_reason` | *Nullable[str]* | :heavy_check_mark: | Reason the generation finished | stop | +| `generation_time` | *Nullable[float]* | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | +| `http_referer` | *Nullable[str]* | :heavy_check_mark: | Referer header from the request | | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | +| `is_byok` | *bool* | :heavy_check_mark: | Whether this used bring-your-own-key | false | +| `latency` | *Nullable[float]* | :heavy_check_mark: | Total latency in milliseconds | 1250 | +| `model` | *str* | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | +| `moderation_latency` | *Nullable[float]* | :heavy_check_mark: | Moderation latency in milliseconds | 50 | +| `native_finish_reason` | *Nullable[str]* | :heavy_check_mark: | Native finish reason as reported by provider | stop | +| `native_tokens_cached` | *Nullable[int]* | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | +| `native_tokens_completion` | *Nullable[int]* | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | +| `native_tokens_completion_images` | *Nullable[int]* | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | +| `native_tokens_prompt` | *Nullable[int]* | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | +| `native_tokens_reasoning` | *Nullable[int]* | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | +| `num_fetches` | *Nullable[int]* | :heavy_check_mark: | Number of web fetches performed | 0 | +| `num_input_audio_prompt` | *Nullable[int]* | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | +| `num_media_completion` | *Nullable[int]* | :heavy_check_mark: | Number of media items in the completion | 0 | +| `num_media_prompt` | *Nullable[int]* | :heavy_check_mark: | Number of media items in the prompt | 1 | +| `num_search_results` | *Nullable[int]* | :heavy_check_mark: | Number of search results included | 5 | +| `origin` | *str* | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | +| `preset_id` | *Nullable[str]* | :heavy_check_mark: | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | +| `provider_name` | *Nullable[str]* | :heavy_check_mark: | Name of the provider that served the request | Infermatic | +| `provider_responses` | List[[components.ProviderResponse](../components/providerresponse.mdx)] | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | +| `request_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | +| `response_cache_source_id` | *OptionalNullable[str]* | :heavy_minus_sign: | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | +| `router` | *Nullable[str]* | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | +| `service_tier` | *Nullable[str]* | :heavy_check_mark: | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | +| `session_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Session identifier grouping multiple generations in the same session | | +| `streamed` | *Nullable[bool]* | :heavy_check_mark: | Whether the response was streamed | true | +| `tokens_completion` | *Nullable[int]* | :heavy_check_mark: | Number of tokens in the completion | 25 | +| `tokens_prompt` | *Nullable[int]* | :heavy_check_mark: | Number of tokens in the prompt | 10 | +| `total_cost` | *float* | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | +| `upstream_id` | *Nullable[str]* | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | +| `upstream_inference_cost` | *Nullable[float]* | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | +| `usage` | *float* | :heavy_check_mark: | Usage amount in USD | 0.0015 | +| `user_agent` | *Nullable[str]* | :heavy_check_mark: | User-Agent header from the request | | +| `web_search_engine` | *Nullable[str]* | :heavy_check_mark: | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | +| `workspace_id` | *Nullable[str]* | :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/components/getbyokkeyresponse.mdx b/docs/components/getbyokkeyresponse.mdx index 2e804eda0..30d5539cf 100644 --- a/docs/components/getbyokkeyresponse.mdx +++ b/docs/components/getbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "GetBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.BYOKKey](../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](../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/components/getguardrailresponse.mdx b/docs/components/getguardrailresponse.mdx index efc2eb464..c17bc0e82 100644 --- a/docs/components/getguardrailresponse.mdx +++ b/docs/components/getguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "GetGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Guardrail](../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](../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/components/getobservabilitydestinationresponse.mdx b/docs/components/getobservabilitydestinationresponse.mdx index 7e611ac42..f6bfadc5c 100644 --- a/docs/components/getobservabilitydestinationresponse.mdx +++ b/docs/components/getobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "GetObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ObservabilityDestination](../components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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](../components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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/components/getpresetresponse.mdx b/docs/components/getpresetresponse.mdx index 3606318ff..2af502a12 100644 --- a/docs/components/getpresetresponse.mdx +++ b/docs/components/getpresetresponse.mdx @@ -9,4 +9,4 @@ A preset with its currently designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.PresetWithDesignatedVersion](../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](../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/components/getpresetversionresponse.mdx b/docs/components/getpresetversionresponse.mdx index 6de20820b..6c3040281 100644 --- a/docs/components/getpresetversionresponse.mdx +++ b/docs/components/getpresetversionresponse.mdx @@ -9,4 +9,4 @@ A single version of a preset. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [Nullable[components.PresetDesignatedVersion]](../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` | [Nullable[components.PresetDesignatedVersion]](../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/components/getscimgroupmappingresponse.mdx b/docs/components/getscimgroupmappingresponse.mdx index 43dd8b19c..3031bf112 100644 --- a/docs/components/getscimgroupmappingresponse.mdx +++ b/docs/components/getscimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "GetScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ScimGroupMapping](../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](../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/components/getscimsyncjobresponse.mdx b/docs/components/getscimsyncjobresponse.mdx index d1d7d379f..e671eabcb 100644 --- a/docs/components/getscimsyncjobresponse.mdx +++ b/docs/components/getscimsyncjobresponse.mdx @@ -6,4 +6,4 @@ title: "GetScimSyncJobResponse" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | [components.ScimSyncJob](../components/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.ScimSyncJob](../components/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/gettoolresponse.mdx b/docs/components/gettoolresponse.mdx index 1f9a0aaba..50b8d7f4b 100644 --- a/docs/components/gettoolresponse.mdx +++ b/docs/components/gettoolresponse.mdx @@ -6,4 +6,4 @@ title: "GetToolResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `data` | [components.ServerToolDetails](../components/servertooldetails.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.ServerToolDetails](../components/servertooldetails.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/getworkspacebudgetresponse.mdx b/docs/components/getworkspacebudgetresponse.mdx index 9222134d2..2974de1ff 100644 --- a/docs/components/getworkspacebudgetresponse.mdx +++ b/docs/components/getworkspacebudgetresponse.mdx @@ -6,5 +6,5 @@ title: "GetWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.WorkspaceBudget](../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"
} | -| `include_byok_in_budgets` | *Optional[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](../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"
} | +| `include_byok_in_budgets` | *Optional[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/components/getworkspaceresponse.mdx b/docs/components/getworkspaceresponse.mdx index e533fcc3c..3028ce13a 100644 --- a/docs/components/getworkspaceresponse.mdx +++ b/docs/components/getworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "GetWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Workspace](../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](../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/components/goneresponseerrordata.mdx b/docs/components/goneresponseerrordata.mdx index 44a775cac..79c5d5a9f 100644 --- a/docs/components/goneresponseerrordata.mdx +++ b/docs/components/goneresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for GoneResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/guardrail.mdx b/docs/components/guardrail.mdx index 655cfc1f7..2f0f384b3 100644 --- a/docs/components/guardrail.mdx +++ b/docs/components/guardrail.mdx @@ -6,28 +6,29 @@ title: "Guardrail" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | -| `allowed_models` | List[*str*] | ➖ | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `allowed_providers` | List[*str*] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntry](../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../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"
}
] | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `description` | *OptionalNullable[str]* | ➖ | Description of the guardrail | Guardrail for production environment | -| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`enforce_zdr`~~ | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `id` | *str* | ✅ | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `ignored_models` | List[*str*] | ➖ | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | -| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *bool* | ✅ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. | false | -| `limit_usd` | *OptionalNullable[float]* | ➖ | Spending limit in USD | 100 | -| `name` | *str* | ✅ | Name of the guardrail | Production Guardrail | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `updated_at` | *OptionalNullable[str]* | ➖ | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | -| `workspace_id` | *Nullable[str]* | ✅ | 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 +| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | true | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | +| `allowed_models` | List[*str*] | :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"
] | +| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntry](../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../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"
}
] | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | +| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`enforce_zdr`~~ | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | +| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *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 | +| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 100 | +| `name` | *str* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `updated_at` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | +| `workspace_id` | *Nullable[str]* | :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/components/image.mdx b/docs/components/image.mdx index 714f6fb66..36a2381e7 100644 --- a/docs/components/image.mdx +++ b/docs/components/image.mdx @@ -6,5 +6,5 @@ title: "Image" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `image_url` | [components.BatchObjectImageURL](../components/batchobjectimageurl.mdx) | ✅ | N/A | -| `type` | [components.ChoiceTypeImageURL](../components/choicetypeimageurl.mdx) | ✅ | N/A | \ No newline at end of file +| `image_url` | [components.BatchObjectImageURL](../components/batchobjectimageurl.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.ChoiceTypeImageURL](../components/choicetypeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/imageendpoint.mdx b/docs/components/imageendpoint.mdx index 036b01ff1..29fa84c13 100644 --- a/docs/components/imageendpoint.mdx +++ b/docs/components/imageendpoint.mdx @@ -9,10 +9,10 @@ An endpoint that serves a given image model. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_passthrough_parameters` | List[*str*] | ✅ | Provider-specific options accepted under provider.options[provider_slug]. | [] | -| `pricing` | List[[components.ImagePricingEntry](../components/imagepricingentry.mdx)] | ✅ | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | -| `provider_name` | *str* | ✅ | Provider display name | Bytedance | -| `provider_slug` | *str* | ✅ | Provider slug | bytedance | -| `provider_tag` | *Nullable[str]* | ✅ | Provider tag for request-side selection | bytedance | -| `supported_parameters` | Dict[str, [components.CapabilityDescriptor](../components/capabilitydescriptor.mdx)] | ✅ | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | -| `supports_streaming` | *bool* | ✅ | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file +| `allowed_passthrough_parameters` | List[*str*] | :heavy_check_mark: | Provider-specific options accepted under provider.options[provider_slug]. | [] | +| `pricing` | List[[components.ImagePricingEntry](../components/imagepricingentry.mdx)] | :heavy_check_mark: | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | +| `provider_name` | *str* | :heavy_check_mark: | Provider display name | Bytedance | +| `provider_slug` | *str* | :heavy_check_mark: | Provider slug | bytedance | +| `provider_tag` | *Nullable[str]* | :heavy_check_mark: | Provider tag for request-side selection | bytedance | +| `supported_parameters` | Dict[str, [components.CapabilityDescriptor](../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"
}
} | +| `supports_streaming` | *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/components/imagegencallcompletedevent.mdx b/docs/components/imagegencallcompletedevent.mdx index 7657c7727..2ca428b13 100644 --- a/docs/components/imagegencallcompletedevent.mdx +++ b/docs/components/imagegencallcompletedevent.mdx @@ -9,7 +9,7 @@ Image generation call completed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ImageGenCallCompletedEventType](../components/imagegencallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ImageGenCallCompletedEventType](../components/imagegencallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/imagegencallgeneratingevent.mdx b/docs/components/imagegencallgeneratingevent.mdx index 60d65c905..eb3a1af69 100644 --- a/docs/components/imagegencallgeneratingevent.mdx +++ b/docs/components/imagegencallgeneratingevent.mdx @@ -9,7 +9,7 @@ Image generation call is generating | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ImageGenCallGeneratingEventType](../components/imagegencallgeneratingeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ImageGenCallGeneratingEventType](../components/imagegencallgeneratingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/imagegencallinprogressevent.mdx b/docs/components/imagegencallinprogressevent.mdx index fec386c86..72ce2bb45 100644 --- a/docs/components/imagegencallinprogressevent.mdx +++ b/docs/components/imagegencallinprogressevent.mdx @@ -9,7 +9,7 @@ Image generation call in progress | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ImageGenCallInProgressEventType](../components/imagegencallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ImageGenCallInProgressEventType](../components/imagegencallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/imagegencallpartialimageevent.mdx b/docs/components/imagegencallpartialimageevent.mdx index 4f4c5acad..a3b82a920 100644 --- a/docs/components/imagegencallpartialimageevent.mdx +++ b/docs/components/imagegencallpartialimageevent.mdx @@ -9,9 +9,9 @@ Image generation call with partial image | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `partial_image_b64` | *str* | ✅ | N/A | -| `partial_image_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ImageGenCallPartialImageEventType](../components/imagegencallpartialimageeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `partial_image_b64` | *str* | :heavy_check_mark: | N/A | +| `partial_image_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ImageGenCallPartialImageEventType](../components/imagegencallpartialimageeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/imagegencompletedevent.mdx b/docs/components/imagegencompletedevent.mdx index 1c59c7589..247d9e47e 100644 --- a/docs/components/imagegencompletedevent.mdx +++ b/docs/components/imagegencompletedevent.mdx @@ -9,8 +9,8 @@ Emitted when generation completes and the final image is available | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `b64_json` | *str* | ✅ | Base64-encoded final image data | | -| `created` | *int* | ✅ | Unix timestamp (seconds) when the image was generated | | -| `media_type` | *Optional[str]* | ➖ | 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](../components/imagegencompletedeventtype.mdx) | ✅ | The event type | | -| `usage` | [Optional[components.ImageGenerationUsage]](../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 +| `b64_json` | *str* | :heavy_check_mark: | Base64-encoded final image data | | +| `created` | *int* | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | | +| `media_type` | *Optional[str]* | :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](../components/imagegencompletedeventtype.mdx) | :heavy_check_mark: | The event type | | +| `usage` | [Optional[components.ImageGenerationUsage]](../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/components/imagegeneration.mdx b/docs/components/imagegeneration.mdx index 77cb82034..55213d229 100644 --- a/docs/components/imagegeneration.mdx +++ b/docs/components/imagegeneration.mdx @@ -6,6 +6,6 @@ title: "ImageGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/imagegenerationproviderpreferences.mdx b/docs/components/imagegenerationproviderpreferences.mdx index 600054638..b98f786f6 100644 --- a/docs/components/imagegenerationproviderpreferences.mdx +++ b/docs/components/imagegenerationproviderpreferences.mdx @@ -9,9 +9,9 @@ Provider routing preferences and provider-specific passthrough configuration. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allow_fallbacks` | *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` | List[[components.ImageGenerationProviderPreferencesIgnore](../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` | List[[components.ImageGenerationProviderPreferencesOnly](../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` | [Optional[components.ImageGenerationProviderPreferencesOptions]](../components/imagegenerationproviderpreferencesoptions.mdx) | ➖ | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | -| `order` | List[[components.ImageGenerationProviderPreferencesOrder](../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[components.ImageGenerationProviderPreferencesSort]](../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 +| `allow_fallbacks` | *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` | List[[components.ImageGenerationProviderPreferencesIgnore](../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` | List[[components.ImageGenerationProviderPreferencesOnly](../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` | [Optional[components.ImageGenerationProviderPreferencesOptions]](../components/imagegenerationproviderpreferencesoptions.mdx) | :heavy_minus_sign: | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | +| `order` | List[[components.ImageGenerationProviderPreferencesOrder](../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[components.ImageGenerationProviderPreferencesSort]](../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/components/imagegenerationproviderpreferencesoptions.mdx b/docs/components/imagegenerationproviderpreferencesoptions.mdx index 25fbab524..815789c44 100644 --- a/docs/components/imagegenerationproviderpreferencesoptions.mdx +++ b/docs/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` | Dict[str, *Any*] | ➖ | N/A | -| `ai21` | Dict[str, *Any*] | ➖ | N/A | -| `aion_labs` | Dict[str, *Any*] | ➖ | N/A | -| `akashml` | Dict[str, *Any*] | ➖ | N/A | -| `alibaba` | Dict[str, *Any*] | ➖ | N/A | -| `amazon_bedrock` | Dict[str, *Any*] | ➖ | N/A | -| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | -| `amazon_nova` | Dict[str, *Any*] | ➖ | N/A | -| `ambient` | Dict[str, *Any*] | ➖ | N/A | -| `anthropic` | Dict[str, *Any*] | ➖ | N/A | -| `anthropic_2` | Dict[str, *Any*] | ➖ | N/A | -| `anyscale` | Dict[str, *Any*] | ➖ | N/A | -| `arcee_ai` | Dict[str, *Any*] | ➖ | N/A | -| `assemblyai` | Dict[str, *Any*] | ➖ | N/A | -| `atlas_cloud` | Dict[str, *Any*] | ➖ | N/A | -| `atoma` | Dict[str, *Any*] | ➖ | N/A | -| `avian` | Dict[str, *Any*] | ➖ | N/A | -| `azure` | Dict[str, *Any*] | ➖ | N/A | -| `baidu` | Dict[str, *Any*] | ➖ | N/A | -| `baseten` | Dict[str, *Any*] | ➖ | N/A | -| `black_forest_labs` | Dict[str, *Any*] | ➖ | N/A | -| `byteplus` | Dict[str, *Any*] | ➖ | N/A | -| `centml` | Dict[str, *Any*] | ➖ | N/A | -| `cerebras` | Dict[str, *Any*] | ➖ | N/A | -| `chutes` | Dict[str, *Any*] | ➖ | N/A | -| `cirrascale` | Dict[str, *Any*] | ➖ | N/A | -| `clarifai` | Dict[str, *Any*] | ➖ | N/A | -| `claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | -| `cloudflare` | Dict[str, *Any*] | ➖ | N/A | -| `cohere` | Dict[str, *Any*] | ➖ | N/A | -| `coreweave` | Dict[str, *Any*] | ➖ | N/A | -| `cosine` | Dict[str, *Any*] | ➖ | N/A | -| `crofai` | Dict[str, *Any*] | ➖ | N/A | -| `crucible` | Dict[str, *Any*] | ➖ | N/A | -| `crusoe` | Dict[str, *Any*] | ➖ | N/A | -| `darkbloom` | Dict[str, *Any*] | ➖ | N/A | -| `databricks` | Dict[str, *Any*] | ➖ | N/A | -| `decart` | Dict[str, *Any*] | ➖ | N/A | -| `deepgram` | Dict[str, *Any*] | ➖ | N/A | -| `deepinfra` | Dict[str, *Any*] | ➖ | N/A | -| `deepseek` | Dict[str, *Any*] | ➖ | N/A | -| `dekallm` | Dict[str, *Any*] | ➖ | N/A | -| `digitalocean` | Dict[str, *Any*] | ➖ | N/A | -| `elevenlabs` | Dict[str, *Any*] | ➖ | N/A | -| `enfer` | Dict[str, *Any*] | ➖ | N/A | -| `fake_provider` | Dict[str, *Any*] | ➖ | N/A | -| `featherless` | Dict[str, *Any*] | ➖ | N/A | -| `fireworks` | Dict[str, *Any*] | ➖ | N/A | -| `fish_audio` | Dict[str, *Any*] | ➖ | N/A | -| `friendli` | Dict[str, *Any*] | ➖ | N/A | -| `gmicloud` | Dict[str, *Any*] | ➖ | N/A | -| `google_ai_studio` | Dict[str, *Any*] | ➖ | N/A | -| `google_vertex` | Dict[str, *Any*] | ➖ | N/A | -| `gopomelo` | Dict[str, *Any*] | ➖ | N/A | -| `groq` | Dict[str, *Any*] | ➖ | N/A | -| `heygen` | Dict[str, *Any*] | ➖ | N/A | -| `huggingface` | Dict[str, *Any*] | ➖ | N/A | -| `hyperbolic` | Dict[str, *Any*] | ➖ | N/A | -| `hyperbolic_quantized` | Dict[str, *Any*] | ➖ | N/A | -| `inception` | Dict[str, *Any*] | ➖ | N/A | -| `inceptron` | Dict[str, *Any*] | ➖ | N/A | -| `inferact_vllm` | Dict[str, *Any*] | ➖ | N/A | -| `inference_net` | Dict[str, *Any*] | ➖ | N/A | -| `infermatic` | Dict[str, *Any*] | ➖ | N/A | -| `inflection` | Dict[str, *Any*] | ➖ | N/A | -| `inocloud` | Dict[str, *Any*] | ➖ | N/A | -| `io_net` | Dict[str, *Any*] | ➖ | N/A | -| `ionstream` | Dict[str, *Any*] | ➖ | N/A | -| `klusterai` | Dict[str, *Any*] | ➖ | N/A | -| `krea` | Dict[str, *Any*] | ➖ | N/A | -| `lambda_` | Dict[str, *Any*] | ➖ | N/A | -| `lepton` | Dict[str, *Any*] | ➖ | N/A | -| `liquid` | Dict[str, *Any*] | ➖ | N/A | -| `lynn` | Dict[str, *Any*] | ➖ | N/A | -| `lynn_private` | Dict[str, *Any*] | ➖ | N/A | -| `makora` | Dict[str, *Any*] | ➖ | N/A | -| `mancer` | Dict[str, *Any*] | ➖ | N/A | -| `mancer_old` | Dict[str, *Any*] | ➖ | N/A | -| `mara` | Dict[str, *Any*] | ➖ | N/A | -| `meta` | Dict[str, *Any*] | ➖ | N/A | -| `minimax` | Dict[str, *Any*] | ➖ | N/A | -| `mistral` | Dict[str, *Any*] | ➖ | N/A | -| `modal` | Dict[str, *Any*] | ➖ | N/A | -| `modelrun` | Dict[str, *Any*] | ➖ | N/A | -| `modular` | Dict[str, *Any*] | ➖ | N/A | -| `moonshotai` | Dict[str, *Any*] | ➖ | N/A | -| `morph` | Dict[str, *Any*] | ➖ | N/A | -| `ncompass` | Dict[str, *Any*] | ➖ | N/A | -| `near_ai` | Dict[str, *Any*] | ➖ | N/A | -| `nebius` | Dict[str, *Any*] | ➖ | N/A | -| `nex_agi` | Dict[str, *Any*] | ➖ | N/A | -| `nextbit` | Dict[str, *Any*] | ➖ | N/A | -| `nineteen` | Dict[str, *Any*] | ➖ | N/A | -| `novita` | Dict[str, *Any*] | ➖ | N/A | -| `nvidia` | Dict[str, *Any*] | ➖ | N/A | -| `octoai` | Dict[str, *Any*] | ➖ | N/A | -| `ollama` | Dict[str, *Any*] | ➖ | N/A | -| `open_inference` | Dict[str, *Any*] | ➖ | N/A | -| `openai` | Dict[str, *Any*] | ➖ | N/A | -| `parasail` | Dict[str, *Any*] | ➖ | N/A | -| `perceptron` | Dict[str, *Any*] | ➖ | N/A | -| `perplexity` | Dict[str, *Any*] | ➖ | N/A | -| `phala` | Dict[str, *Any*] | ➖ | N/A | -| `poolside` | Dict[str, *Any*] | ➖ | N/A | -| `primeintellect` | Dict[str, *Any*] | ➖ | N/A | -| `quiver` | Dict[str, *Any*] | ➖ | N/A | -| `recraft` | Dict[str, *Any*] | ➖ | N/A | -| `recursal` | Dict[str, *Any*] | ➖ | N/A | -| `reflection` | Dict[str, *Any*] | ➖ | N/A | -| `reka` | Dict[str, *Any*] | ➖ | N/A | -| `relace` | Dict[str, *Any*] | ➖ | N/A | -| `replicate` | Dict[str, *Any*] | ➖ | N/A | -| `respan` | Dict[str, *Any*] | ➖ | N/A | -| `runway` | Dict[str, *Any*] | ➖ | N/A | -| `sail_research` | Dict[str, *Any*] | ➖ | N/A | -| `sakana` | Dict[str, *Any*] | ➖ | N/A | -| `sakana_ai` | Dict[str, *Any*] | ➖ | N/A | -| `sambanova` | Dict[str, *Any*] | ➖ | N/A | -| `sambanova_cloaked` | Dict[str, *Any*] | ➖ | N/A | -| `scaledown` | Dict[str, *Any*] | ➖ | N/A | -| `seed` | Dict[str, *Any*] | ➖ | N/A | -| `sf_compute` | Dict[str, *Any*] | ➖ | N/A | -| `siliconflow` | Dict[str, *Any*] | ➖ | N/A | -| `sourceful` | Dict[str, *Any*] | ➖ | N/A | -| `stealth` | Dict[str, *Any*] | ➖ | N/A | -| `stepfun` | Dict[str, *Any*] | ➖ | N/A | -| `streamlake` | Dict[str, *Any*] | ➖ | N/A | -| `switchpoint` | Dict[str, *Any*] | ➖ | N/A | -| `targon` | Dict[str, *Any*] | ➖ | N/A | -| `tencent` | Dict[str, *Any*] | ➖ | N/A | -| `tenstorrent` | Dict[str, *Any*] | ➖ | N/A | -| `thinkingmachines` | Dict[str, *Any*] | ➖ | N/A | -| `together` | Dict[str, *Any*] | ➖ | N/A | -| `together_lite` | Dict[str, *Any*] | ➖ | N/A | -| `typesafe` | Dict[str, *Any*] | ➖ | N/A | -| `ubicloud` | Dict[str, *Any*] | ➖ | N/A | -| `unbiased` | Dict[str, *Any*] | ➖ | N/A | -| `upstage` | Dict[str, *Any*] | ➖ | N/A | -| `venice` | Dict[str, *Any*] | ➖ | N/A | -| `voyageai` | Dict[str, *Any*] | ➖ | N/A | -| `wafer` | Dict[str, *Any*] | ➖ | N/A | -| `wandb` | Dict[str, *Any*] | ➖ | N/A | -| `wandb_legacy` | Dict[str, *Any*] | ➖ | N/A | -| `xai` | Dict[str, *Any*] | ➖ | N/A | -| `xiaomi` | Dict[str, *Any*] | ➖ | N/A | -| `z_ai` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `oneai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ai21` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `aion_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `akashml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `alibaba` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `amazon_bedrock` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `amazon_nova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ambient` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `anthropic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `anthropic_2` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `anyscale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `arcee_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `assemblyai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `atlas_cloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `atoma` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `avian` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `azure` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `baidu` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `baseten` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `black_forest_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `byteplus` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `centml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cerebras` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `chutes` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cirrascale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `clarifai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cloudflare` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cohere` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `coreweave` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cosine` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `crofai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `crucible` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `crusoe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `darkbloom` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `databricks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `decart` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deepgram` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deepinfra` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deepseek` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `dekallm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `digitalocean` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `elevenlabs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `enfer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fake_provider` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `featherless` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fireworks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fish_audio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `friendli` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `gmicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `google_ai_studio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `google_vertex` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `gopomelo` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `groq` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `heygen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `huggingface` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `hyperbolic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `hyperbolic_quantized` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inception` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inferact_vllm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inference_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `infermatic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inocloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `io_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ionstream` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `klusterai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `krea` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lambda_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lepton` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `liquid` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lynn` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lynn_private` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `makora` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mancer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mancer_old` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mara` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `meta` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `minimax` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mistral` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `modal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `modelrun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `modular` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `moonshotai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `morph` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ncompass` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `near_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nebius` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nex_agi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nextbit` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nineteen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `novita` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nvidia` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `octoai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ollama` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `open_inference` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `openai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `parasail` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `perceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `perplexity` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `phala` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `poolside` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `primeintellect` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `quiver` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `recraft` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `recursal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `reflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `reka` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `relace` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `replicate` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `respan` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `runway` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sail_research` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sakana` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sakana_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sambanova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sambanova_cloaked` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `scaledown` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `seed` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sf_compute` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `siliconflow` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sourceful` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `stealth` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `stepfun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `streamlake` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `switchpoint` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `targon` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `tencent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `tenstorrent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `thinkingmachines` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `together` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `together_lite` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `typesafe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ubicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `unbiased` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `upstage` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `venice` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `voyageai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `wafer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `wandb` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `wandb_legacy` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `xai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `xiaomi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `z_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/imagegenerationrequest.mdx b/docs/components/imagegenerationrequest.mdx index 8f03555a9..6c22de5c8 100644 --- a/docs/components/imagegenerationrequest.mdx +++ b/docs/components/imagegenerationrequest.mdx @@ -9,20 +9,20 @@ Image generation request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `aspect_ratio` | [Optional[components.ImageGenerationRequestAspectRatio]](../components/imagegenerationrequestaspectratio.mdx) | ➖ | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | -| `background` | [Optional[components.ImageGenerationRequestBackground]](../components/imagegenerationrequestbackground.mdx) | ➖ | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | -| `input_references` | List[[components.ContentPartImage](../components/contentpartimage.mdx)] | ➖ | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | -| `model` | *str* | ✅ | The image generation model to use | bytedance-seed/seedream-4.5 | -| `n` | *Optional[int]* | ➖ | 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 | -| `output_compression` | *Optional[int]* | ➖ | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | -| `output_format` | [Optional[components.ImageGenerationRequestOutputFormat]](../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` | *str* | ✅ | Text description of the desired image | a red panda astronaut floating in space, studio lighting | -| `provider` | [Optional[components.ImageGenerationProviderPreferences]](../components/imagegenerationproviderpreferences.mdx) | ➖ | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | -| `quality` | [Optional[components.ImageGenerationRequestQuality]](../components/imagegenerationrequestquality.mdx) | ➖ | Rendering quality. Providers without a quality knob ignore this. | high | -| `resolution` | [Optional[components.ImageGenerationRequestResolution]](../components/imagegenerationrequestresolution.mdx) | ➖ | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | -| `seed` | *Optional[int]* | ➖ | 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. | | -| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | *Optional[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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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 +| `aspect_ratio` | [Optional[components.ImageGenerationRequestAspectRatio]](../components/imagegenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | +| `background` | [Optional[components.ImageGenerationRequestBackground]](../components/imagegenerationrequestbackground.mdx) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | +| `input_references` | List[[components.ContentPartImage](../components/contentpartimage.mdx)] | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | +| `model` | *str* | :heavy_check_mark: | The image generation model to use | bytedance-seed/seedream-4.5 | +| `n` | *Optional[int]* | :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 | +| `output_compression` | *Optional[int]* | :heavy_minus_sign: | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | +| `output_format` | [Optional[components.ImageGenerationRequestOutputFormat]](../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` | *str* | :heavy_check_mark: | Text description of the desired image | a red panda astronaut floating in space, studio lighting | +| `provider` | [Optional[components.ImageGenerationProviderPreferences]](../components/imagegenerationproviderpreferences.mdx) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | +| `quality` | [Optional[components.ImageGenerationRequestQuality]](../components/imagegenerationrequestquality.mdx) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | +| `resolution` | [Optional[components.ImageGenerationRequestResolution]](../components/imagegenerationrequestresolution.mdx) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | +| `seed` | *Optional[int]* | :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. | | +| `session_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | *Optional[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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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/components/imagegenerationresponse.mdx b/docs/components/imagegenerationresponse.mdx index 84bbadd89..b6e0e2c0d 100644 --- a/docs/components/imagegenerationresponse.mdx +++ b/docs/components/imagegenerationresponse.mdx @@ -9,6 +9,6 @@ Image generation response | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `created` | *int* | ✅ | Unix timestamp (seconds) when the image was generated | 1748372400 | -| `data` | List[[components.ImageGenerationResponseData](../components/imagegenerationresponsedata.mdx)] | ✅ | Generated images | | -| `usage` | [Optional[components.ImageGenerationUsage]](../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` | *int* | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | 1748372400 | +| `data` | List[[components.ImageGenerationResponseData](../components/imagegenerationresponsedata.mdx)] | :heavy_check_mark: | Generated images | | +| `usage` | [Optional[components.ImageGenerationUsage]](../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/components/imagegenerationresponsedata.mdx b/docs/components/imagegenerationresponsedata.mdx index e5f6cb265..e36ed8937 100644 --- a/docs/components/imagegenerationresponsedata.mdx +++ b/docs/components/imagegenerationresponsedata.mdx @@ -6,5 +6,5 @@ title: "ImageGenerationResponseData" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `b64_json` | *str* | ✅ | Base64-encoded image bytes | | -| `media_type` | *Optional[str]* | ➖ | 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 +| `b64_json` | *str* | :heavy_check_mark: | Base64-encoded image bytes | | +| `media_type` | *Optional[str]* | :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/components/imagegenerationservertool.mdx b/docs/components/imagegenerationservertool.mdx index 76374aab4..c620407af 100644 --- a/docs/components/imagegenerationservertool.mdx +++ b/docs/components/imagegenerationservertool.mdx @@ -9,14 +9,14 @@ Image generation tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `background` | [Optional[components.ImageGenerationServerToolBackground]](../components/imagegenerationservertoolbackground.mdx) | ➖ | N/A | -| `input_fidelity` | [OptionalNullable[components.InputFidelity]](../components/inputfidelity.mdx) | ➖ | N/A | -| `input_image_mask` | [Optional[components.InputImageMask]](../components/inputimagemask.mdx) | ➖ | N/A | -| `model` | *Optional[str]* | ➖ | N/A | -| `moderation` | [Optional[components.Moderation]](../components/moderation.mdx) | ➖ | N/A | -| `output_compression` | *Optional[int]* | ➖ | N/A | -| `output_format` | [Optional[components.ImageGenerationServerToolOutputFormat]](../components/imagegenerationservertooloutputformat.mdx) | ➖ | N/A | -| `partial_images` | *Optional[int]* | ➖ | N/A | -| `quality` | [Optional[components.ImageGenerationServerToolQuality]](../components/imagegenerationservertoolquality.mdx) | ➖ | N/A | -| `size` | *Optional[str]* | ➖ | N/A | -| `type` | [components.ImageGenerationServerToolType](../components/imagegenerationservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `background` | [Optional[components.ImageGenerationServerToolBackground]](../components/imagegenerationservertoolbackground.mdx) | :heavy_minus_sign: | N/A | +| `input_fidelity` | [OptionalNullable[components.InputFidelity]](../components/inputfidelity.mdx) | :heavy_minus_sign: | N/A | +| `input_image_mask` | [Optional[components.InputImageMask]](../components/inputimagemask.mdx) | :heavy_minus_sign: | N/A | +| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `moderation` | [Optional[components.Moderation]](../components/moderation.mdx) | :heavy_minus_sign: | N/A | +| `output_compression` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `output_format` | [Optional[components.ImageGenerationServerToolOutputFormat]](../components/imagegenerationservertooloutputformat.mdx) | :heavy_minus_sign: | N/A | +| `partial_images` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `quality` | [Optional[components.ImageGenerationServerToolQuality]](../components/imagegenerationservertoolquality.mdx) | :heavy_minus_sign: | N/A | +| `size` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.ImageGenerationServerToolType](../components/imagegenerationservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/imagegenerationservertoolconfig.mdx b/docs/components/imagegenerationservertoolconfig.mdx index f0e1a009f..3fc78f9b0 100644 --- a/docs/components/imagegenerationservertoolconfig.mdx +++ b/docs/components/imagegenerationservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:image_generation server tool. Accepts all image | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `model` | *Optional[str]* | ➖ | Which image generation model to use (e.g. "openai/gpt-5-image"). Defaults to "openai/gpt-5-image". | openai/gpt-5-image | -| `__pydantic_extra__` | Dict[str, [components.ImageGenerationServerToolConfigUnion](../components/imagegenerationservertoolconfigunion.mdx)] | ➖ | N/A | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | \ No newline at end of file +| `model` | *Optional[str]* | :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 | +| `__pydantic_extra__` | Dict[str, [components.ImageGenerationServerToolConfigUnion](../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/components/imagegenerationservertoolopenrouter.mdx b/docs/components/imagegenerationservertoolopenrouter.mdx index 213c2a253..0caf29cf4 100644 --- a/docs/components/imagegenerationservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.ImageGenerationServerToolConfig]](../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](../components/imagegenerationservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.ImageGenerationServerToolConfig]](../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](../components/imagegenerationservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/imagegenerationusage.mdx b/docs/components/imagegenerationusage.mdx index 8c2539d3c..fa7df815c 100644 --- a/docs/components/imagegenerationusage.mdx +++ b/docs/components/imagegenerationusage.mdx @@ -9,16 +9,16 @@ Token and cost usage for the image generation request, when available | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completion_tokens` | *int* | ✅ | The tokens generated | | -| `completion_tokens_details` | [OptionalNullable[components.ImageGenerationUsageCompletionTokensDetails]](../components/imagegenerationusagecompletiontokensdetails.mdx) | ➖ | N/A | | -| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | -| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | | -| `prompt_tokens_details` | [OptionalNullable[components.ImageGenerationUsagePromptTokensDetails]](../components/imagegenerationusageprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | -| `server_tool_use` | [OptionalNullable[components.ImageGenerationUsageServerToolUse]](../components/imagegenerationusageservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | -| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | -| `total_tokens` | *int* | ✅ | Sum of the above two fields | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | | +| `completion_tokens_details` | [OptionalNullable[components.ImageGenerationUsageCompletionTokensDetails]](../components/imagegenerationusagecompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | +| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | +| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | | +| `prompt_tokens_details` | [OptionalNullable[components.ImageGenerationUsagePromptTokensDetails]](../components/imagegenerationusageprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `server_tool_use` | [OptionalNullable[components.ImageGenerationUsageServerToolUse]](../components/imagegenerationusageservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | +| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/components/imagegenerationusagecompletiontokensdetails.mdx b/docs/components/imagegenerationusagecompletiontokensdetails.mdx index 5cf574f66..9c56a843c 100644 --- a/docs/components/imagegenerationusagecompletiontokensdetails.mdx +++ b/docs/components/imagegenerationusagecompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "ImageGenerationUsageCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/imagegenerationusageprompttokensdetails.mdx b/docs/components/imagegenerationusageprompttokensdetails.mdx index 48330d542..a00b12547 100644 --- a/docs/components/imagegenerationusageprompttokensdetails.mdx +++ b/docs/components/imagegenerationusageprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/imagegenerationusageservertooluse.mdx b/docs/components/imagegenerationusageservertooluse.mdx index 81518f32a..427cf8d0f 100644 --- a/docs/components/imagegenerationusageservertooluse.mdx +++ b/docs/components/imagegenerationusageservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | -| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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 +| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | :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. | +| `web_search_requests` | *OptionalNullable[int]* | :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/components/imagegenpartialimageevent.mdx b/docs/components/imagegenpartialimageevent.mdx index 947b96713..b081c1148 100644 --- a/docs/components/imagegenpartialimageevent.mdx +++ b/docs/components/imagegenpartialimageevent.mdx @@ -9,6 +9,6 @@ Emitted when a partial image becomes available during streaming generation | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `b64_json` | *str* | ✅ | Base64-encoded partial image data | -| `partial_image_index` | *int* | ✅ | 0-based index indicating which partial image this is in the sequence | -| `type` | [components.ImageGenPartialImageEventType](../components/imagegenpartialimageeventtype.mdx) | ✅ | The event type | \ No newline at end of file +| `b64_json` | *str* | :heavy_check_mark: | Base64-encoded partial image data | +| `partial_image_index` | *int* | :heavy_check_mark: | 0-based index indicating which partial image this is in the sequence | +| `type` | [components.ImageGenPartialImageEventType](../components/imagegenpartialimageeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/components/imagegenstreamerrorevent.mdx b/docs/components/imagegenstreamerrorevent.mdx index 75ba7aca1..befd44245 100644 --- a/docs/components/imagegenstreamerrorevent.mdx +++ b/docs/components/imagegenstreamerrorevent.mdx @@ -9,5 +9,5 @@ Emitted when streaming generation fails after the SSE response starts | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `error` | [components.ImageGenStreamErrorEventError](../components/imagegenstreamerroreventerror.mdx) | ✅ | Provider error details | -| `type` | [components.ImageGenStreamErrorEventType](../components/imagegenstreamerroreventtype.mdx) | ✅ | The event type | \ No newline at end of file +| `error` | [components.ImageGenStreamErrorEventError](../components/imagegenstreamerroreventerror.mdx) | :heavy_check_mark: | Provider error details | +| `type` | [components.ImageGenStreamErrorEventType](../components/imagegenstreamerroreventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/components/imagegenstreamerroreventerror.mdx b/docs/components/imagegenstreamerroreventerror.mdx index c6acc34e5..8539997c0 100644 --- a/docs/components/imagegenstreamerroreventerror.mdx +++ b/docs/components/imagegenstreamerroreventerror.mdx @@ -9,7 +9,7 @@ Provider error details | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `code` | *OptionalNullable[str]* | ➖ | Provider error code, when supplied | -| `message` | *str* | ✅ | Provider error message | -| `param` | *OptionalNullable[str]* | ➖ | Request parameter associated with the error, when supplied | -| `type` | *OptionalNullable[str]* | ➖ | Provider error type, when supplied | \ No newline at end of file +| `code` | *OptionalNullable[str]* | :heavy_minus_sign: | Provider error code, when supplied | +| `message` | *str* | :heavy_check_mark: | Provider error message | +| `param` | *OptionalNullable[str]* | :heavy_minus_sign: | Request parameter associated with the error, when supplied | +| `type` | *OptionalNullable[str]* | :heavy_minus_sign: | Provider error type, when supplied | \ No newline at end of file diff --git a/docs/components/imagegentextchunkevent.mdx b/docs/components/imagegentextchunkevent.mdx index 637fe9e45..9c2837aab 100644 --- a/docs/components/imagegentextchunkevent.mdx +++ b/docs/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](../components/imagegentextchunkeventphase.mdx) | ✅ | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | -| `text` | *str* | ✅ | A text fragment of the image being generated (e.g. partial SVG markup) | -| `type` | [components.ImageGenTextChunkEventType](../components/imagegentextchunkeventtype.mdx) | ✅ | The event type | \ No newline at end of file +| `phase` | [components.ImageGenTextChunkEventPhase](../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` | *str* | :heavy_check_mark: | A text fragment of the image being generated (e.g. partial SVG markup) | +| `type` | [components.ImageGenTextChunkEventType](../components/imagegentextchunkeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/components/imagemodelarchitecture.mdx b/docs/components/imagemodelarchitecture.mdx index 1c86917c8..860b66299 100644 --- a/docs/components/imagemodelarchitecture.mdx +++ b/docs/components/imagemodelarchitecture.mdx @@ -6,5 +6,5 @@ title: "ImageModelArchitecture" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `input_modalities` | List[[components.ImageInputModality](../components/imageinputmodality.mdx)] | ✅ | Supported input modalities | -| `output_modalities` | List[[components.ImageOutputModality](../components/imageoutputmodality.mdx)] | ✅ | Supported output modalities | \ No newline at end of file +| `input_modalities` | List[[components.ImageInputModality](../components/imageinputmodality.mdx)] | :heavy_check_mark: | Supported input modalities | +| `output_modalities` | List[[components.ImageOutputModality](../components/imageoutputmodality.mdx)] | :heavy_check_mark: | Supported output modalities | \ No newline at end of file diff --git a/docs/components/imagemodelendpointsresponse.mdx b/docs/components/imagemodelendpointsresponse.mdx index dd3d632a7..7d3ec9ccf 100644 --- a/docs/components/imagemodelendpointsresponse.mdx +++ b/docs/components/imagemodelendpointsresponse.mdx @@ -9,5 +9,5 @@ The full per-endpoint records for an image model. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `endpoints` | List[[components.ImageEndpoint](../components/imageendpoint.mdx)] | ✅ | N/A | | -| `id` | *str* | ✅ | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file +| `endpoints` | List[[components.ImageEndpoint](../components/imageendpoint.mdx)] | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file diff --git a/docs/components/imagemodellistitem.mdx b/docs/components/imagemodellistitem.mdx index e6a900bcb..633c99be2 100644 --- a/docs/components/imagemodellistitem.mdx +++ b/docs/components/imagemodellistitem.mdx @@ -9,11 +9,11 @@ A single image model in the discovery listing. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [components.ImageModelArchitecture](../components/imagemodelarchitecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | -| `created` | *int* | ✅ | Unix timestamp (seconds) of when the model was created | 1692901234 | -| `description` | *str* | ✅ | N/A | A text-to-image model. | -| `endpoints` | *str* | ✅ | Relative URL to the full per-endpoint records for this model | /api/v1/images/models/bytedance-seed/seedream-4.5/endpoints | -| `id` | *str* | ✅ | Model slug | bytedance-seed/seedream-4.5 | -| `name` | *str* | ✅ | Display name | Seedream 4.5 | -| `supported_parameters` | Dict[str, [components.CapabilityDescriptor](../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"
}
} | -| `supports_streaming` | *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](../components/imagemodelarchitecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | +| `created` | *int* | :heavy_check_mark: | Unix timestamp (seconds) of when the model was created | 1692901234 | +| `description` | *str* | :heavy_check_mark: | N/A | A text-to-image model. | +| `endpoints` | *str* | :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` | *str* | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | +| `name` | *str* | :heavy_check_mark: | Display name | Seedream 4.5 | +| `supported_parameters` | Dict[str, [components.CapabilityDescriptor](../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"
}
} | +| `supports_streaming` | *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/components/imagemodelslistresponse.mdx b/docs/components/imagemodelslistresponse.mdx index 545dcf6bf..b5d695bd1 100644 --- a/docs/components/imagemodelslistresponse.mdx +++ b/docs/components/imagemodelslistresponse.mdx @@ -9,4 +9,4 @@ List of image generation models. | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `data` | List[[components.ImageModelListItem](../components/imagemodellistitem.mdx)] | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.ImageModelListItem](../components/imagemodellistitem.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/imagepricingentry.mdx b/docs/components/imagepricingentry.mdx index 5a774b9ee..8381e7e71 100644 --- a/docs/components/imagepricingentry.mdx +++ b/docs/components/imagepricingentry.mdx @@ -9,7 +9,7 @@ One billable pricing line for an image provider. | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `billable` | [components.Billable](../components/billable.mdx) | ✅ | N/A | -| `cost_usd` | *float* | ✅ | N/A | -| `unit` | [components.Unit](../components/unit.mdx) | ✅ | N/A | -| `variant` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `billable` | [components.Billable](../components/billable.mdx) | :heavy_check_mark: | N/A | +| `cost_usd` | *float* | :heavy_check_mark: | N/A | +| `unit` | [components.Unit](../components/unit.mdx) | :heavy_check_mark: | N/A | +| `variant` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/imagestreamingresponse.mdx b/docs/components/imagestreamingresponse.mdx index 7274b1f69..8aad6cc34 100644 --- a/docs/components/imagestreamingresponse.mdx +++ b/docs/components/imagestreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ImageStreamingResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `data` | [components.ImageStreamingResponseData](../components/imagestreamingresponsedata.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.ImageStreamingResponseData](../components/imagestreamingresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/incompletedetails.mdx b/docs/components/incompletedetails.mdx index 0cb88a681..33c9c9317 100644 --- a/docs/components/incompletedetails.mdx +++ b/docs/components/incompletedetails.mdx @@ -6,4 +6,4 @@ title: "IncompleteDetails" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `reason` | [Optional[components.IncompleteDetailsReason]](../components/incompletedetailsreason.mdx) | ➖ | N/A | \ No newline at end of file +| `reason` | [Optional[components.IncompleteDetailsReason]](../components/incompletedetailsreason.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/input1.mdx b/docs/components/input1.mdx index dc88a4bb7..43245bc10 100644 --- a/docs/components/input1.mdx +++ b/docs/components/input1.mdx @@ -6,4 +6,4 @@ title: "Input1" | Field | Type | Required | Description | Example | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `prompt` | *str* | ✅ | N/A | What is the meaning of life? | \ No newline at end of file +| `prompt` | *str* | :heavy_check_mark: | N/A | What is the meaning of life? | \ No newline at end of file diff --git a/docs/components/input2.mdx b/docs/components/input2.mdx index 0f37fdb22..8ff9ce181 100644 --- a/docs/components/input2.mdx +++ b/docs/components/input2.mdx @@ -6,4 +6,4 @@ title: "Input2" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `messages` | List[*Any*] | ✅ | N/A | [
\{
"content": "What is the meaning of life?",
"role": "user"
}
] | \ No newline at end of file +| `messages` | List[*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/components/inputaudio.mdx b/docs/components/inputaudio.mdx index 02d932037..54aba1db8 100644 --- a/docs/components/inputaudio.mdx +++ b/docs/components/inputaudio.mdx @@ -9,5 +9,5 @@ Audio input content item | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `input_audio` | [components.InputAudioInputAudio](../components/inputaudioinputaudio.mdx) | ✅ | N/A | -| `type` | [components.InputAudioType](../components/inputaudiotype.mdx) | ✅ | N/A | \ No newline at end of file +| `input_audio` | [components.InputAudioInputAudio](../components/inputaudioinputaudio.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.InputAudioType](../components/inputaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/inputaudioinputaudio.mdx b/docs/components/inputaudioinputaudio.mdx index a625bd45c..29ec9c922 100644 --- a/docs/components/inputaudioinputaudio.mdx +++ b/docs/components/inputaudioinputaudio.mdx @@ -6,5 +6,5 @@ title: "InputAudioInputAudio" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `data` | *str* | ✅ | N/A | -| `format_` | [components.FormatEnum](../components/formatenum.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | *str* | :heavy_check_mark: | N/A | +| `format_` | [components.FormatEnum](../components/formatenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/inputfile.mdx b/docs/components/inputfile.mdx index 07a5d8f38..2e4a15d5c 100644 --- a/docs/components/inputfile.mdx +++ b/docs/components/inputfile.mdx @@ -9,8 +9,8 @@ File input content item | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `file_data` | *Optional[str]* | ➖ | N/A | -| `file_id` | *OptionalNullable[str]* | ➖ | N/A | -| `file_url` | *Optional[str]* | ➖ | N/A | -| `filename` | *Optional[str]* | ➖ | N/A | -| `type` | [components.InputFileType](../components/inputfiletype.mdx) | ✅ | N/A | \ No newline at end of file +| `file_data` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `file_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `filename` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.InputFileType](../components/inputfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/inputimage.mdx b/docs/components/inputimage.mdx index 0fe16f7b0..c4b373901 100644 --- a/docs/components/inputimage.mdx +++ b/docs/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](../components/inputimagedetail.mdx) | ✅ | N/A | -| `file_id` | *OptionalNullable[str]* | ➖ | N/A | -| `image_url` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.InputImageType](../components/inputimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `detail` | [components.InputImageDetail](../components/inputimagedetail.mdx) | :heavy_check_mark: | N/A | +| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.InputImageType](../components/inputimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/inputimagemask.mdx b/docs/components/inputimagemask.mdx index 2092337ea..74ce00775 100644 --- a/docs/components/inputimagemask.mdx +++ b/docs/components/inputimagemask.mdx @@ -6,5 +6,5 @@ title: "InputImageMask" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `file_id` | *Optional[str]* | ➖ | N/A | -| `image_url` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `file_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/inputmessageitem.mdx b/docs/components/inputmessageitem.mdx index f1fed10b2..0a2f6e5d2 100644 --- a/docs/components/inputmessageitem.mdx +++ b/docs/components/inputmessageitem.mdx @@ -6,7 +6,7 @@ title: "InputMessageItem" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `content` | List[[components.InputMessageItemContentUnion](../components/inputmessageitemcontentunion.mdx)] | ➖ | N/A | -| `id` | *Optional[str]* | ➖ | N/A | -| `role` | [components.InputMessageItemRoleUnion](../components/inputmessageitemroleunion.mdx) | ✅ | N/A | -| `type` | [Optional[components.InputMessageItemTypeMessage]](../components/inputmessageitemtypemessage.mdx) | ➖ | N/A | \ No newline at end of file +| `content` | List[[components.InputMessageItemContentUnion](../components/inputmessageitemcontentunion.mdx)] | :heavy_minus_sign: | N/A | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `role` | [components.InputMessageItemRoleUnion](../components/inputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | +| `type` | [Optional[components.InputMessageItemTypeMessage]](../components/inputmessageitemtypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/inputmessageitemcontentinputimage.mdx b/docs/components/inputmessageitemcontentinputimage.mdx index 27a6f7fe6..6c503806b 100644 --- a/docs/components/inputmessageitemcontentinputimage.mdx +++ b/docs/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](../components/inputmessageitemdetail.mdx) | ✅ | N/A | -| `file_id` | *OptionalNullable[str]* | ➖ | N/A | -| `image_url` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.InputMessageItemTypeInputImage](../components/inputmessageitemtypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file +| `detail` | [components.InputMessageItemDetail](../components/inputmessageitemdetail.mdx) | :heavy_check_mark: | N/A | +| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.InputMessageItemTypeInputImage](../components/inputmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/inputschema.mdx b/docs/components/inputschema.mdx index 85c82024c..c86a4f23d 100644 --- a/docs/components/inputschema.mdx +++ b/docs/components/inputschema.mdx @@ -6,7 +6,7 @@ title: "InputSchema" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `properties` | *Optional[Any]* | ➖ | N/A | -| `required` | List[*str*] | ➖ | N/A | -| `type` | *Optional[str]* | ➖ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `properties` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `required` | List[*str*] | :heavy_minus_sign: | N/A | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/inputsmessage.mdx b/docs/components/inputsmessage.mdx index 9b45ed32f..f64aa8de6 100644 --- a/docs/components/inputsmessage.mdx +++ b/docs/components/inputsmessage.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [Nullable[components.InputsContent2]](../components/inputscontent2.mdx) | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `phase` | [OptionalNullable[components.InputsPhaseUnion]](../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](../components/inputsrole.mdx) | ✅ | N/A | -| `status` | [Optional[components.InputsStatusUnion1]](../components/inputsstatusunion1.mdx) | ➖ | N/A | -| `type` | [Optional[components.InputsTypeMessage]](../components/inputstypemessage.mdx) | ➖ | N/A | \ No newline at end of file +| `content` | [Nullable[components.InputsContent2]](../components/inputscontent2.mdx) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `phase` | [OptionalNullable[components.InputsPhaseUnion]](../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](../components/inputsrole.mdx) | :heavy_check_mark: | N/A | +| `status` | [Optional[components.InputsStatusUnion1]](../components/inputsstatusunion1.mdx) | :heavy_minus_sign: | N/A | +| `type` | [Optional[components.InputsTypeMessage]](../components/inputstypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/inputsreasoning.mdx b/docs/components/inputsreasoning.mdx index ecd382f46..60e9a1a60 100644 --- a/docs/components/inputsreasoning.mdx +++ b/docs/components/inputsreasoning.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | ➖ | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `status` | [Optional[components.InputsStatusUnion2]](../components/inputsstatusunion2.mdx) | ➖ | N/A | | -| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | ✅ | N/A | | -| `type` | [components.InputsTypeReasoning](../components/inputstypereasoning.mdx) | ✅ | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | -| `signature` | *OptionalNullable[str]* | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `status` | [Optional[components.InputsStatusUnion2]](../components/inputsstatusunion2.mdx) | :heavy_minus_sign: | N/A | | +| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | :heavy_check_mark: | N/A | | +| `type` | [components.InputsTypeReasoning](../components/inputstypereasoning.mdx) | :heavy_check_mark: | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/components/inputtext.mdx b/docs/components/inputtext.mdx index cf4c5888a..590841308 100644 --- a/docs/components/inputtext.mdx +++ b/docs/components/inputtext.mdx @@ -9,6 +9,6 @@ Text input content item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `prompt_cache_breakpoint` | [OptionalNullable[components.PromptCacheBreakpoint]](../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` | *str* | ✅ | N/A | | -| `type` | [components.InputTextType](../components/inputtexttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `prompt_cache_breakpoint` | [OptionalNullable[components.PromptCacheBreakpoint]](../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` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.InputTextType](../components/inputtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/inputtokensdetails.mdx b/docs/components/inputtokensdetails.mdx index 0b1d333f6..daa531b4e 100644 --- a/docs/components/inputtokensdetails.mdx +++ b/docs/components/inputtokensdetails.mdx @@ -6,5 +6,5 @@ title: "InputTokensDetails" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | N/A | -| `cached_tokens` | *int* | ✅ | N/A | \ No newline at end of file +| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | +| `cached_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/inputvideo.mdx b/docs/components/inputvideo.mdx index ba5fa2253..c7e3967e6 100644 --- a/docs/components/inputvideo.mdx +++ b/docs/components/inputvideo.mdx @@ -9,6 +9,6 @@ Video input content item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `processing` | [Optional[components.InputVideoProcessing]](../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](../components/inputvideotype.mdx) | ✅ | N/A | | -| `video_url` | *str* | ✅ | A base64 data URL or remote URL that resolves to a video file | | \ No newline at end of file +| `processing` | [Optional[components.InputVideoProcessing]](../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](../components/inputvideotype.mdx) | :heavy_check_mark: | N/A | | +| `video_url` | *str* | :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/components/intern.mdx b/docs/components/intern.mdx index d7a6f76e2..71f5da0f9 100644 --- a/docs/components/intern.mdx +++ b/docs/components/intern.mdx @@ -9,17 +9,17 @@ Public lifecycle state and settings for one intern. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `attached_vault_id` | *Nullable[str]* | ✅ | Vault the intern borrows from another intern, or null when it borrows none. | -| `created_at` | *str* | ✅ | ISO 8601 creation time. | -| `description` | *Nullable[str]* | ✅ | Free-form description. | -| `hostname` | *Nullable[str]* | ✅ | Public hostname the intern is reachable at, or null until provisioning has assigned one. | -| `id` | *str* | ✅ | Intern id. | -| `instructions` | *Nullable[str]* | ✅ | Standing instructions the intern boots with. | -| `last_failure_message` | *Nullable[str]* | ✅ | Why the last provisioning attempt failed, when status is failed. | -| `model` | *Nullable[str]* | ✅ | OpenRouter model slug the intern runs, or null for the workspace default. | -| `name` | *str* | ✅ | Intern name, unique per creator within a workspace. | -| `progress` | [Nullable[components.Progress]](../components/progress.mdx) | ✅ | Active provisioning step, or null once provisioning has settled. | -| `status` | [components.InternStatus](../components/internstatus.mdx) | ✅ | Lifecycle status. | -| `updated_at` | *str* | ✅ | ISO 8601 last update time. | -| `vault_id` | *Nullable[str]* | ✅ | Vault the intern owns, or null before it has been created. | -| `workspace_id` | *str* | ✅ | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file +| `attached_vault_id` | *Nullable[str]* | :heavy_check_mark: | Vault the intern borrows from another intern, or null when it borrows none. | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 creation time. | +| `description` | *Nullable[str]* | :heavy_check_mark: | Free-form description. | +| `hostname` | *Nullable[str]* | :heavy_check_mark: | Public hostname the intern is reachable at, or null until provisioning has assigned one. | +| `id` | *str* | :heavy_check_mark: | Intern id. | +| `instructions` | *Nullable[str]* | :heavy_check_mark: | Standing instructions the intern boots with. | +| `last_failure_message` | *Nullable[str]* | :heavy_check_mark: | Why the last provisioning attempt failed, when status is failed. | +| `model` | *Nullable[str]* | :heavy_check_mark: | OpenRouter model slug the intern runs, or null for the workspace default. | +| `name` | *str* | :heavy_check_mark: | Intern name, unique per creator within a workspace. | +| `progress` | [Nullable[components.Progress]](../components/progress.mdx) | :heavy_check_mark: | Active provisioning step, or null once provisioning has settled. | +| `status` | [components.InternStatus](../components/internstatus.mdx) | :heavy_check_mark: | Lifecycle status. | +| `updated_at` | *str* | :heavy_check_mark: | ISO 8601 last update time. | +| `vault_id` | *Nullable[str]* | :heavy_check_mark: | Vault the intern owns, or null before it has been created. | +| `workspace_id` | *str* | :heavy_check_mark: | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file diff --git a/docs/components/internalserverresponseerrordata.mdx b/docs/components/internalserverresponseerrordata.mdx index 11ab52ab0..8ddf14e86 100644 --- a/docs/components/internalserverresponseerrordata.mdx +++ b/docs/components/internalserverresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for InternalServerResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/internchatassistantmessage.mdx b/docs/components/internchatassistantmessage.mdx index f28152771..3334fd334 100644 --- a/docs/components/internchatassistantmessage.mdx +++ b/docs/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[components.InternChatMessageContent]](../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](../components/internchatassistantmessagerole.mdx) | ✅ | N/A | | -| `tool_calls` | List[[components.InternChatEchoedToolCall](../components/internchatechoedtoolcall.mdx)] | ➖ | N/A | | \ No newline at end of file +| `content` | [OptionalNullable[components.InternChatMessageContent]](../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](../components/internchatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | +| `tool_calls` | List[[components.InternChatEchoedToolCall](../components/internchatechoedtoolcall.mdx)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/internchatchoice.mdx b/docs/components/internchatchoice.mdx index 4ae3de477..7d0bdde08 100644 --- a/docs/components/internchatchoice.mdx +++ b/docs/components/internchatchoice.mdx @@ -9,6 +9,6 @@ The single choice this endpoint streams. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `delta` | [components.InternChatDelta](../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"
} | -| `finish_reason` | [Nullable[components.InternChatChoiceFinishReason]](../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` | *int* | ✅ | N/A | | \ No newline at end of file +| `delta` | [components.InternChatDelta](../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"
} | +| `finish_reason` | [Nullable[components.InternChatChoiceFinishReason]](../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` | *int* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/internchatcompletionchunk.mdx b/docs/components/internchatcompletionchunk.mdx index 49dd63e5e..9f35a80a9 100644 --- a/docs/components/internchatcompletionchunk.mdx +++ b/docs/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` | List[[components.InternChatChoice](../components/internchatchoice.mdx)] | ✅ | One choice on content, tool-call and error chunks. Empty on the final chunk that carries `session_id`. | | -| `created` | *int* | ✅ | N/A | | -| `error` | [Optional[components.InternChatStreamError]](../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` | *str* | ✅ | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | -| `model` | *str* | ✅ | 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](../components/internchatcompletionchunkobject.mdx) | ✅ | N/A | | -| `session_id` | *OptionalNullable[str]* | ➖ | 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[components.InternChatUsage]](../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` | List[[components.InternChatChoice](../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` | *int* | :heavy_check_mark: | N/A | | +| `error` | [Optional[components.InternChatStreamError]](../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` | *str* | :heavy_check_mark: | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | +| `model` | *str* | :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](../components/internchatcompletionchunkobject.mdx) | :heavy_check_mark: | N/A | | +| `session_id` | *OptionalNullable[str]* | :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[components.InternChatUsage]](../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/components/internchatcompletionrequest.mdx b/docs/components/internchatcompletionrequest.mdx index 26a29d7b9..ea77f21bc 100644 --- a/docs/components/internchatcompletionrequest.mdx +++ b/docs/components/internchatcompletionrequest.mdx @@ -9,8 +9,8 @@ An OpenAI-compatible streaming chat completion request for one intern. Other Ope | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `approval_mode` | [Optional[components.InternApprovalMode]](../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` | List[[components.InternChatMessage](../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` | *Optional[str]* | ➖ | 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 | -| `session_id` | *Optional[str]* | ➖ | 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` | *Literal[True]* | ✅ | 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 +| `approval_mode` | [Optional[components.InternApprovalMode]](../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` | List[[components.InternChatMessage](../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` | *Optional[str]* | :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 | +| `session_id` | *Optional[str]* | :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` | *Literal[True]* | :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/components/internchatdelta.mdx b/docs/components/internchatdelta.mdx index 62b50f774..950f73d45 100644 --- a/docs/components/internchatdelta.mdx +++ b/docs/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` | *Optional[str]* | ➖ | N/A | -| `reasoning` | *Optional[str]* | ➖ | N/A | -| `role` | [Optional[components.InternChatDeltaRole]](../components/internchatdeltarole.mdx) | ➖ | N/A | -| `tool_calls` | List[[components.InternChatToolCall](../components/internchattoolcall.mdx)] | ➖ | N/A | \ No newline at end of file +| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `reasoning` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `role` | [Optional[components.InternChatDeltaRole]](../components/internchatdeltarole.mdx) | :heavy_minus_sign: | N/A | +| `tool_calls` | List[[components.InternChatToolCall](../components/internchattoolcall.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/internchatdevelopermessage.mdx b/docs/components/internchatdevelopermessage.mdx index 9c2f8fa14..0fd5f0fbf 100644 --- a/docs/components/internchatdevelopermessage.mdx +++ b/docs/components/internchatdevelopermessage.mdx @@ -9,5 +9,5 @@ A developer message. Accepted for client compatibility and not forwarded. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatdevelopermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatdevelopermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/internchatechoedtoolcall.mdx b/docs/components/internchatechoedtoolcall.mdx index 4daf2bb5e..a869fcac2 100644 --- a/docs/components/internchatechoedtoolcall.mdx +++ b/docs/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](../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` | *str* | ✅ | N/A | | \ No newline at end of file +| `function` | [components.InternChatEchoedToolCallFunction](../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` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/internchatechoedtoolcallfunction.mdx b/docs/components/internchatechoedtoolcallfunction.mdx index a8a640eeb..7b057bd6a 100644 --- a/docs/components/internchatechoedtoolcallfunction.mdx +++ b/docs/components/internchatechoedtoolcallfunction.mdx @@ -9,5 +9,5 @@ The function name and JSON arguments string exactly as streamed. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `arguments` | *str* | ✅ | N/A | -| `name` | *str* | ✅ | N/A | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/internchaterror.mdx b/docs/components/internchaterror.mdx index 288e1147c..84af96295 100644 --- a/docs/components/internchaterror.mdx +++ b/docs/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` | *int* | ✅ | The HTTP status of the response. | | -| `message` | *str* | ✅ | N/A | | -| `metadata` | [Optional[components.InternChatErrorMetadata]](../components/internchaterrormetadata.mdx) | ➖ | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | The HTTP status of the response. | | +| `message` | *str* | :heavy_check_mark: | N/A | | +| `metadata` | [Optional[components.InternChatErrorMetadata]](../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/components/internchaterrormetadata.mdx b/docs/components/internchaterrormetadata.mdx index 19b1afb7b..0e5c6b605 100644 --- a/docs/components/internchaterrormetadata.mdx +++ b/docs/components/internchaterrormetadata.mdx @@ -9,5 +9,5 @@ Machine-readable detail for the failure. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `reason` | [components.InternChatErrorMetadataReason](../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](../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/components/internchatprompttokensdetails.mdx b/docs/components/internchatprompttokensdetails.mdx index 2aab9333f..77b2e3417 100644 --- a/docs/components/internchatprompttokensdetails.mdx +++ b/docs/components/internchatprompttokensdetails.mdx @@ -9,4 +9,4 @@ Prompt tokens served from cache, when the daemon reported them. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `cached_tokens` | *int* | ✅ | N/A | \ No newline at end of file +| `cached_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/internchatsteeredresponse.mdx b/docs/components/internchatsteeredresponse.mdx index 44a8a6b0c..51fdf7178 100644 --- a/docs/components/internchatsteeredresponse.mdx +++ b/docs/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 | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `session_id` | *str* | ✅ | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | -| `status` | [components.InternChatSteeredResponseStatus](../components/internchatsteeredresponsestatus.mdx) | ✅ | The message was handed to the turn already running on this session. | | \ No newline at end of file +| `session_id` | *str* | :heavy_check_mark: | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | +| `status` | [components.InternChatSteeredResponseStatus](../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/components/internchatstreamerror.mdx b/docs/components/internchatstreamerror.mdx index f6abede1c..b19200571 100644 --- a/docs/components/internchatstreamerror.mdx +++ b/docs/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` | *int* | ✅ | The HTTP status this failure would have had before the stream opened. | | -| `message` | *str* | ✅ | N/A | | -| `metadata` | [components.InternChatErrorMetadata](../components/internchaterrormetadata.mdx) | ✅ | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | The HTTP status this failure would have had before the stream opened. | | +| `message` | *str* | :heavy_check_mark: | N/A | | +| `metadata` | [components.InternChatErrorMetadata](../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/components/internchatstreamingresponse.mdx b/docs/components/internchatstreamingresponse.mdx index 496aa77ff..04ad18b61 100644 --- a/docs/components/internchatstreamingresponse.mdx +++ b/docs/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](../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](../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/components/internchatsystemmessage.mdx b/docs/components/internchatsystemmessage.mdx index 7c5aa907c..d45683415 100644 --- a/docs/components/internchatsystemmessage.mdx +++ b/docs/components/internchatsystemmessage.mdx @@ -9,5 +9,5 @@ A system message. Accepted for client compatibility and not forwarded. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatsystemmessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatsystemmessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/internchattextpart.mdx b/docs/components/internchattextpart.mdx index 239809409..0bd3a5dc9 100644 --- a/docs/components/internchattextpart.mdx +++ b/docs/components/internchattextpart.mdx @@ -9,5 +9,5 @@ One text part of a message. | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `text` | *str* | ✅ | N/A | -| `type` | [components.InternChatTextPartType](../components/internchattextparttype.mdx) | ✅ | N/A | \ No newline at end of file +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.InternChatTextPartType](../components/internchattextparttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/internchattoolcall.mdx b/docs/components/internchattoolcall.mdx index 082d06ac4..6176afe83 100644 --- a/docs/components/internchattoolcall.mdx +++ b/docs/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](../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` | *str* | ✅ | The interaction id. Send it back as `tool_call_id` on the `tool` message that answers it. | 15e90ad6-5320-4a59-af4f-b371428154fa | -| `index` | *int* | ✅ | N/A | | -| `type` | [components.InternChatToolCallType](../components/internchattoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `function` | [components.InternChatToolCallFunction](../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` | *str* | :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` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.InternChatToolCallType](../components/internchattoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/internchattoolcallfunction.mdx b/docs/components/internchattoolcallfunction.mdx index fd934b305..918fa0b27 100644 --- a/docs/components/internchattoolcallfunction.mdx +++ b/docs/components/internchattoolcallfunction.mdx @@ -9,5 +9,5 @@ The single tool this endpoint calls, asking the caller for input. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | ✅ | 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](../components/internchattoolcallfunctionname.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *str* | :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](../components/internchattoolcallfunctionname.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/internchattoolmessage.mdx b/docs/components/internchattoolmessage.mdx index 6a80386bb..f2673d01f 100644 --- a/docs/components/internchattoolmessage.mdx +++ b/docs/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` | [Nullable[components.InternChatMessageContent]](../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](../components/internchattoolmessagerole.mdx) | ✅ | N/A | | -| `tool_call_id` | *str* | ✅ | N/A | | \ No newline at end of file +| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchattoolmessagerole.mdx) | :heavy_check_mark: | N/A | | +| `tool_call_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/internchatusage.mdx b/docs/components/internchatusage.mdx index 7d4ea67d4..221095cfd 100644 --- a/docs/components/internchatusage.mdx +++ b/docs/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 | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `completion_tokens` | *int* | ✅ | N/A | | -| `cost` | *Optional[float]* | ➖ | The cost of the run in USD, when the daemon reported one. | | -| `prompt_tokens` | *int* | ✅ | N/A | | -| `prompt_tokens_details` | [Optional[components.InternChatPromptTokensDetails]](../components/internchatprompttokensdetails.mdx) | ➖ | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | -| `total_tokens` | *int* | ✅ | N/A | | \ No newline at end of file +| `completion_tokens` | *int* | :heavy_check_mark: | N/A | | +| `cost` | *Optional[float]* | :heavy_minus_sign: | The cost of the run in USD, when the daemon reported one. | | +| `prompt_tokens` | *int* | :heavy_check_mark: | N/A | | +| `prompt_tokens_details` | [Optional[components.InternChatPromptTokensDetails]](../components/internchatprompttokensdetails.mdx) | :heavy_minus_sign: | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | +| `total_tokens` | *int* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/internchatusermessage.mdx b/docs/components/internchatusermessage.mdx index 22469972a..55aae5818 100644 --- a/docs/components/internchatusermessage.mdx +++ b/docs/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` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatusermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatusermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/interndaemonaccess.mdx b/docs/components/interndaemonaccess.mdx index 4bf141df9..7a564fb42 100644 --- a/docs/components/interndaemonaccess.mdx +++ b/docs/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` | *str* | ✅ | N/A | -| `token` | *str* | ✅ | N/A | \ No newline at end of file +| `origin` | *str* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/interninvokeacceptedresponse.mdx b/docs/components/interninvokeacceptedresponse.mdx index cf0a574a8..bcec63f8d 100644 --- a/docs/components/interninvokeacceptedresponse.mdx +++ b/docs/components/interninvokeacceptedresponse.mdx @@ -9,5 +9,5 @@ The intern admitted the prompt. The run continues on the intern. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `session_id` | *str* | ✅ | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | -| `status` | [components.InternInvokeAcceptedResponseStatus](../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 +| `session_id` | *str* | :heavy_check_mark: | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | +| `status` | [components.InternInvokeAcceptedResponseStatus](../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/components/interninvokerequest.mdx b/docs/components/interninvokerequest.mdx index 8f1fdf4ac..01ec56d1b 100644 --- a/docs/components/interninvokerequest.mdx +++ b/docs/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` | *str* | ✅ | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | -| `session_id` | *Optional[str]* | ➖ | 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` | *str* | :heavy_check_mark: | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | +| `session_id` | *Optional[str]* | :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/components/internlifecycleerrorerror.mdx b/docs/components/internlifecycleerrorerror.mdx index f4cfd7cb4..dc3a8f402 100644 --- a/docs/components/internlifecycleerrorerror.mdx +++ b/docs/components/internlifecycleerrorerror.mdx @@ -6,6 +6,6 @@ title: "InternLifecycleErrorError" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `code` | [components.Code](../components/code.mdx) | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | [Optional[components.InternLifecycleErrorMetadata]](../components/internlifecycleerrormetadata.mdx) | ➖ | N/A | \ No newline at end of file +| `code` | [components.Code](../components/code.mdx) | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | [Optional[components.InternLifecycleErrorMetadata]](../components/internlifecycleerrormetadata.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/internlifecycleerrormetadata.mdx b/docs/components/internlifecycleerrormetadata.mdx index e699b3cdb..f0f458162 100644 --- a/docs/components/internlifecycleerrormetadata.mdx +++ b/docs/components/internlifecycleerrormetadata.mdx @@ -6,5 +6,5 @@ title: "InternLifecycleErrorMetadata" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `reason` | *str* | ✅ | N/A | -| `retryable` | *bool* | ✅ | N/A | \ No newline at end of file +| `reason` | *str* | :heavy_check_mark: | N/A | +| `retryable` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/internlistresponse.mdx b/docs/components/internlistresponse.mdx index ad1d23db6..75702eed1 100644 --- a/docs/components/internlistresponse.mdx +++ b/docs/components/internlistresponse.mdx @@ -9,6 +9,6 @@ Interns visible to the authenticated API key. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | List[[components.Intern](../components/intern.mdx)] | ✅ | N/A | | -| `has_more` | *bool* | ✅ | True when more interns match the current filters. | | -| `next_cursor` | *Optional[str]* | ➖ | 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` | List[[components.Intern](../components/intern.mdx)] | :heavy_check_mark: | N/A | | +| `has_more` | *bool* | :heavy_check_mark: | True when more interns match the current filters. | | +| `next_cursor` | *Optional[str]* | :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/components/itemreferenceitem.mdx b/docs/components/itemreferenceitem.mdx index db89ad466..5d91c205a 100644 --- a/docs/components/itemreferenceitem.mdx +++ b/docs/components/itemreferenceitem.mdx @@ -9,5 +9,5 @@ A reference to a previous response item by ID | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | -| `type` | [components.ItemReferenceItemType](../components/itemreferenceitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ItemReferenceItemType](../components/itemreferenceitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/jevrouterplugin.mdx b/docs/components/jevrouterplugin.mdx index c56d97b12..5cd6cbcf4 100644 --- a/docs/components/jevrouterplugin.mdx +++ b/docs/components/jevrouterplugin.mdx @@ -6,8 +6,8 @@ title: "JevRouterPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | ➖ | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | -| `cost_tier` | *Optional[str]* | ➖ | 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 | -| `excluded_models` | List[*str*] | ➖ | 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](../components/jevrouterpluginid.mdx) | ✅ | N/A | | -| `models` | List[*str*] | ➖ | 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 +| `allowed_models` | List[*str*] | :heavy_minus_sign: | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | +| `cost_tier` | *Optional[str]* | :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 | +| `excluded_models` | List[*str*] | :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](../components/jevrouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `models` | List[*str*] | :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/components/keepall.mdx b/docs/components/keepall.mdx index 2e0dfaa8b..8f65526d9 100644 --- a/docs/components/keepall.mdx +++ b/docs/components/keepall.mdx @@ -6,4 +6,4 @@ title: "KeepAll" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | [components.KeepType](../components/keeptype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.KeepType](../components/keeptype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/key.mdx b/docs/components/key.mdx index 250d73b32..48c2e0831 100644 --- a/docs/components/key.mdx +++ b/docs/components/key.mdx @@ -6,10 +6,10 @@ title: "Key" | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `alg` | [components.Alg](../components/alg.mdx) | ✅ | N/A | -| `crv` | [components.Crv](../components/crv.mdx) | ✅ | N/A | -| `kid` | *str* | ✅ | N/A | -| `kty` | [components.Kty](../components/kty.mdx) | ✅ | N/A | -| `use` | [components.Use](../components/use.mdx) | ✅ | N/A | -| `x` | *str* | ✅ | N/A | -| `y` | *str* | ✅ | N/A | \ No newline at end of file +| `alg` | [components.Alg](../components/alg.mdx) | :heavy_check_mark: | N/A | +| `crv` | [components.Crv](../components/crv.mdx) | :heavy_check_mark: | N/A | +| `kid` | *str* | :heavy_check_mark: | N/A | +| `kty` | [components.Kty](../components/kty.mdx) | :heavy_check_mark: | N/A | +| `use` | [components.Use](../components/use.mdx) | :heavy_check_mark: | N/A | +| `x` | *str* | :heavy_check_mark: | N/A | +| `y` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/keyassignment.mdx b/docs/components/keyassignment.mdx index 67ed953d3..3c18ed0fb 100644 --- a/docs/components/keyassignment.mdx +++ b/docs/components/keyassignment.mdx @@ -6,10 +6,10 @@ title: "KeyAssignment" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `assigned_by` | *Nullable[str]* | ✅ | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrail_id` | *str* | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *str* | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hash` | *str* | ✅ | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `key_label` | *str* | ✅ | Label of the API key | prod-key | -| `key_name` | *str* | ✅ | Name of the API key | Production Key | \ No newline at end of file +| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `key_hash` | *str* | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | +| `key_label` | *str* | :heavy_check_mark: | Label of the API key | prod-key | +| `key_name` | *str* | :heavy_check_mark: | Name of the API key | Production Key | \ No newline at end of file diff --git a/docs/components/keybudget.mdx b/docs/components/keybudget.mdx index 19924410b..e32f03c45 100644 --- a/docs/components/keybudget.mdx +++ b/docs/components/keybudget.mdx @@ -9,12 +9,12 @@ One budget layer that applies to requests made with this key, with the spend enf | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `budget_id` | *Nullable[str]* | ✅ | ID of the workspace budget for the `workspace` scope; null for other scopes. | null | -| `guardrail_id` | *Nullable[str]* | ✅ | ID of the guardrail that carries this budget; null for other scopes. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `include_byok` | *bool* | ✅ | Whether external BYOK inference spend counts toward this budget. | false | -| `limit_usd` | *float* | ✅ | Budget limit in USD for the current window. | 50 | -| `remaining_usd` | *float* | ✅ | `limit_usd - spend_usd`. Zero or negative means this layer rejects requests with a 403 until it resets. | 17.5 | -| `reset_interval` | [Nullable[components.KeyBudgetResetInterval]](../components/keybudgetresetinterval.mdx) | ✅ | UTC window the spend is counted over (weeks start Monday); null for a lifetime budget that never resets. | weekly | -| `resets_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | ISO 8601 UTC instant at which the window rolls over and spend returns to zero; null for a lifetime budget. | 2026-10-12T00:00:00.000Z | -| `scope` | [components.KeyBudgetScope](../components/keybudgetscope.mdx) | ✅ | Which budget layer this is, in the order enforcement checks them: the workspace default guardrail against the member aggregate (`workspace_default_member`) and against this key (`workspace_default_key`), the member guardrail (`member`), the API key guardrail (`api_key`), a workspace budget (`workspace`), or the key's own limit (`key_limit`). | member | -| `spend_usd` | *float* | ✅ | Spend in USD that enforcement counts against this limit in the current window: the member aggregate for member-scoped layers, otherwise this key or workspace. | 32.5 | \ No newline at end of file +| `budget_id` | *Nullable[str]* | :heavy_check_mark: | ID of the workspace budget for the `workspace` scope; null for other scopes. | null | +| `guardrail_id` | *Nullable[str]* | :heavy_check_mark: | ID of the guardrail that carries this budget; null for other scopes. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `include_byok` | *bool* | :heavy_check_mark: | Whether external BYOK inference spend counts toward this budget. | false | +| `limit_usd` | *float* | :heavy_check_mark: | Budget limit in USD for the current window. | 50 | +| `remaining_usd` | *float* | :heavy_check_mark: | `limit_usd - spend_usd`. Zero or negative means this layer rejects requests with a 403 until it resets. | 17.5 | +| `reset_interval` | [Nullable[components.KeyBudgetResetInterval]](../components/keybudgetresetinterval.mdx) | :heavy_check_mark: | UTC window the spend is counted over (weeks start Monday); null for a lifetime budget that never resets. | weekly | +| `resets_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | ISO 8601 UTC instant at which the window rolls over and spend returns to zero; null for a lifetime budget. | 2026-10-12T00:00:00.000Z | +| `scope` | [components.KeyBudgetScope](../components/keybudgetscope.mdx) | :heavy_check_mark: | Which budget layer this is, in the order enforcement checks them: the workspace default guardrail against the member aggregate (`workspace_default_member`) and against this key (`workspace_default_key`), the member guardrail (`member`), the API key guardrail (`api_key`), a workspace budget (`workspace`), or the key's own limit (`key_limit`). | member | +| `spend_usd` | *float* | :heavy_check_mark: | Spend in USD that enforcement counts against this limit in the current window: the member aggregate for member-scoped layers, otherwise this key or workspace. | 32.5 | \ No newline at end of file diff --git a/docs/components/legacychatcontentvideo.mdx b/docs/components/legacychatcontentvideo.mdx index 7affafef7..74b480b1c 100644 --- a/docs/components/legacychatcontentvideo.mdx +++ b/docs/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](../components/legacychatcontentvideotype.mdx) | ✅ | N/A | | -| `video_url` | [components.LegacyChatContentVideoInput](../components/legacychatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `type` | [components.LegacyChatContentVideoType](../components/legacychatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | +| `video_url` | [components.LegacyChatContentVideoInput](../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/components/legacychatcontentvideoinput.mdx b/docs/components/legacychatcontentvideoinput.mdx index 0ad9b1978..83f59a563 100644 --- a/docs/components/legacychatcontentvideoinput.mdx +++ b/docs/components/legacychatcontentvideoinput.mdx @@ -9,5 +9,5 @@ Video input object | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `processing` | [Optional[components.LegacyChatContentVideoInputProcessing]](../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` | *str* | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file +| `processing` | [Optional[components.LegacyChatContentVideoInputProcessing]](../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` | *str* | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/components/legacywebsearchservertool.mdx b/docs/components/legacywebsearchservertool.mdx index 1fb233bb0..fc8f8785b 100644 --- a/docs/components/legacywebsearchservertool.mdx +++ b/docs/components/legacywebsearchservertool.mdx @@ -9,12 +9,12 @@ Web search tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `max_results` | *Optional[int]* | ➖ | 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 | -| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | -| `type` | [components.LegacyWebSearchServerToolType](../components/legacywebsearchservertooltype.mdx) | ✅ | N/A | | -| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../components/websearchuserlocation.mdx) | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `max_results` | *Optional[int]* | :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 | +| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `type` | [components.LegacyWebSearchServerToolType](../components/legacywebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | +| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../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"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/listbyokkeysresponse.mdx b/docs/components/listbyokkeysresponse.mdx index a8e712fe1..4e7fce4c2 100644 --- a/docs/components/listbyokkeysresponse.mdx +++ b/docs/components/listbyokkeysresponse.mdx @@ -6,5 +6,5 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | List[[components.BYOKKey](../components/byokkey.mdx)] | ✅ | List of BYOK credentials. | | -| `total_count` | *int* | ✅ | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file +| `data` | List[[components.BYOKKey](../components/byokkey.mdx)] | :heavy_check_mark: | List of BYOK credentials. | | +| `total_count` | *int* | :heavy_check_mark: | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file diff --git a/docs/components/listendpointsresponse.mdx b/docs/components/listendpointsresponse.mdx index 6bc0bc282..2df1189da 100644 --- a/docs/components/listendpointsresponse.mdx +++ b/docs/components/listendpointsresponse.mdx @@ -9,9 +9,9 @@ List of available endpoints for a model | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [components.Architecture](../components/architecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `created` | *int* | ✅ | Unix timestamp of when the model was created | 1692901234 | -| `description` | *str* | ✅ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `endpoints` | List[[components.PublicEndpoint](../components/publicendpoint.mdx)] | ✅ | List of available endpoints for this model | | -| `id` | *str* | ✅ | Unique identifier for the model | openai/gpt-4 | -| `name` | *str* | ✅ | Display name of the model | GPT-4 | \ No newline at end of file +| `architecture` | [components.Architecture](../components/architecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | +| `description` | *str* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `endpoints` | List[[components.PublicEndpoint](../components/publicendpoint.mdx)] | :heavy_check_mark: | List of available endpoints for this model | | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | +| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | \ No newline at end of file diff --git a/docs/components/listendusersresponse.mdx b/docs/components/listendusersresponse.mdx index 0ba987a1d..b95cdd819 100644 --- a/docs/components/listendusersresponse.mdx +++ b/docs/components/listendusersresponse.mdx @@ -6,5 +6,5 @@ title: "ListEndUsersResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `data` | List[[components.EndUser](../components/enduser.mdx)] | ✅ | N/A | | -| `total_count` | *int* | ✅ | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file +| `data` | List[[components.EndUser](../components/enduser.mdx)] | :heavy_check_mark: | N/A | | +| `total_count` | *int* | :heavy_check_mark: | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file diff --git a/docs/components/listguardrailsresponse.mdx b/docs/components/listguardrailsresponse.mdx index fd933202e..b62bb9a80 100644 --- a/docs/components/listguardrailsresponse.mdx +++ b/docs/components/listguardrailsresponse.mdx @@ -6,5 +6,5 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | List[[components.Guardrail](../components/guardrail.mdx)] | ✅ | List of guardrails | | -| `total_count` | *int* | ✅ | Total number of guardrails | 25 | \ No newline at end of file +| `data` | List[[components.Guardrail](../components/guardrail.mdx)] | :heavy_check_mark: | List of guardrails | | +| `total_count` | *int* | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file diff --git a/docs/components/listkeyassignmentsresponse.mdx b/docs/components/listkeyassignmentsresponse.mdx index f3f456c35..c6806c4ab 100644 --- a/docs/components/listkeyassignmentsresponse.mdx +++ b/docs/components/listkeyassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `data` | List[[components.KeyAssignment](../components/keyassignment.mdx)] | ✅ | List of key assignments | | -| `total_count` | *int* | ✅ | Total number of key assignments for this guardrail | 25 | \ No newline at end of file +| `data` | List[[components.KeyAssignment](../components/keyassignment.mdx)] | :heavy_check_mark: | List of key assignments | | +| `total_count` | *int* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/docs/components/listmemberassignmentsresponse.mdx b/docs/components/listmemberassignmentsresponse.mdx index 498dddf60..9e72b130e 100644 --- a/docs/components/listmemberassignmentsresponse.mdx +++ b/docs/components/listmemberassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | List[[components.MemberAssignment](../components/memberassignment.mdx)] | ✅ | List of member assignments | | -| `total_count` | *int* | ✅ | Total number of member assignments | 10 | \ No newline at end of file +| `data` | List[[components.MemberAssignment](../components/memberassignment.mdx)] | :heavy_check_mark: | List of member assignments | | +| `total_count` | *int* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/docs/components/listobservabilitydestinationsresponse.mdx b/docs/components/listobservabilitydestinationsresponse.mdx index 8d41b819a..912c6caf6 100644 --- a/docs/components/listobservabilitydestinationsresponse.mdx +++ b/docs/components/listobservabilitydestinationsresponse.mdx @@ -6,5 +6,5 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | List[[components.ObservabilityDestination](../components/observabilitydestination.mdx)] | ✅ | List of observability destinations. | | -| `total_count` | *int* | ✅ | Total number of destinations matching the filters. | 1 | \ No newline at end of file +| `data` | List[[components.ObservabilityDestination](../components/observabilitydestination.mdx)] | :heavy_check_mark: | List of observability destinations. | | +| `total_count` | *int* | :heavy_check_mark: | Total number of destinations matching the filters. | 1 | \ No newline at end of file diff --git a/docs/components/listpresetsresponse.mdx b/docs/components/listpresetsresponse.mdx index b2b084fe6..da04cab09 100644 --- a/docs/components/listpresetsresponse.mdx +++ b/docs/components/listpresetsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of presets. | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `data` | List[[components.Preset](../components/preset.mdx)] | ✅ | N/A | -| `total_count` | *int* | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.Preset](../components/preset.mdx)] | :heavy_check_mark: | N/A | +| `total_count` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/listpresetversionsresponse.mdx b/docs/components/listpresetversionsresponse.mdx index 83a88b92f..768df799d 100644 --- a/docs/components/listpresetversionsresponse.mdx +++ b/docs/components/listpresetversionsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of preset versions. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `data` | List[[Nullable[components.PresetDesignatedVersion]](../components/presetdesignatedversion.mdx)] | ✅ | N/A | -| `total_count` | *int* | ✅ | N/A | \ No newline at end of file +| `data` | List[[Nullable[components.PresetDesignatedVersion]](../components/presetdesignatedversion.mdx)] | :heavy_check_mark: | N/A | +| `total_count` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/listprivateendpointsresponse.mdx b/docs/components/listprivateendpointsresponse.mdx index 149357e7f..5eae1fca7 100644 --- a/docs/components/listprivateendpointsresponse.mdx +++ b/docs/components/listprivateendpointsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPrivateEndpointsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `data` | List[[components.PrivateEndpointSummary](../components/privateendpointsummary.mdx)] | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.PrivateEndpointSummary](../components/privateendpointsummary.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/listscimgroupmappingsresponse.mdx b/docs/components/listscimgroupmappingsresponse.mdx index a830bbd09..14dff7d7d 100644 --- a/docs/components/listscimgroupmappingsresponse.mdx +++ b/docs/components/listscimgroupmappingsresponse.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupMappingsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | List[[components.ScimGroupMapping](../components/scimgroupmapping.mdx)] | ✅ | N/A | -| `total_count` | *int* | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.ScimGroupMapping](../components/scimgroupmapping.mdx)] | :heavy_check_mark: | N/A | +| `total_count` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/listscimgroupsresponse.mdx b/docs/components/listscimgroupsresponse.mdx index 69d85e646..6c0e6c816 100644 --- a/docs/components/listscimgroupsresponse.mdx +++ b/docs/components/listscimgroupsresponse.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupsResponse" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | List[[components.ScimGroup](../components/scimgroup.mdx)] | ✅ | N/A | -| `total_count` | *int* | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.ScimGroup](../components/scimgroup.mdx)] | :heavy_check_mark: | N/A | +| `total_count` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/listtoolsresponse.mdx b/docs/components/listtoolsresponse.mdx index 0fcd54cb6..c62bef38e 100644 --- a/docs/components/listtoolsresponse.mdx +++ b/docs/components/listtoolsresponse.mdx @@ -6,6 +6,6 @@ title: "ListToolsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `data` | List[[components.ServerTool](../components/servertool.mdx)] | ✅ | N/A | | -| `links` | [components.ListToolsResponseLinks](../components/listtoolsresponselinks.mdx) | ✅ | N/A | | -| `total_count` | *int* | ✅ | Total number of tools | 12 | \ No newline at end of file +| `data` | List[[components.ServerTool](../components/servertool.mdx)] | :heavy_check_mark: | N/A | | +| `links` | [components.ListToolsResponseLinks](../components/listtoolsresponselinks.mdx) | :heavy_check_mark: | N/A | | +| `total_count` | *int* | :heavy_check_mark: | Total number of tools | 12 | \ No newline at end of file diff --git a/docs/components/listtoolsresponselinks.mdx b/docs/components/listtoolsresponselinks.mdx index 4ef36b167..fe7710735 100644 --- a/docs/components/listtoolsresponselinks.mdx +++ b/docs/components/listtoolsresponselinks.mdx @@ -6,4 +6,4 @@ title: "ListToolsResponseLinks" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `next` | *Nullable[str]* | ✅ | URL for the next page of results, or null if this is the last page | null | \ No newline at end of file +| `next` | *Nullable[str]* | :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/components/listworkspacebudgetsresponse.mdx b/docs/components/listworkspacebudgetsresponse.mdx index 940f25f6b..349ee6c92 100644 --- a/docs/components/listworkspacebudgetsresponse.mdx +++ b/docs/components/listworkspacebudgetsresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspaceBudgetsResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.WorkspaceBudget](../components/workspacebudget.mdx)] | ✅ | List of budgets configured for the workspace | | -| `include_byok_in_budgets` | *Optional[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` | List[[components.WorkspaceBudget](../components/workspacebudget.mdx)] | :heavy_check_mark: | List of budgets configured for the workspace | | +| `include_byok_in_budgets` | *Optional[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/components/listworkspacemembersresponse.mdx b/docs/components/listworkspacemembersresponse.mdx index c311fb895..90edcaf6b 100644 --- a/docs/components/listworkspacemembersresponse.mdx +++ b/docs/components/listworkspacemembersresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | List[[components.WorkspaceMember](../components/workspacemember.mdx)] | ✅ | List of workspace members | | -| `total_count` | *int* | ✅ | Total number of members in the workspace | 5 | \ No newline at end of file +| `data` | List[[components.WorkspaceMember](../components/workspacemember.mdx)] | :heavy_check_mark: | List of workspace members | | +| `total_count` | *int* | :heavy_check_mark: | Total number of members in the workspace | 5 | \ No newline at end of file diff --git a/docs/components/listworkspacesresponse.mdx b/docs/components/listworkspacesresponse.mdx index e84484702..b78013a42 100644 --- a/docs/components/listworkspacesresponse.mdx +++ b/docs/components/listworkspacesresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | List[[components.Workspace](../components/workspace.mdx)] | ✅ | List of workspaces | | -| `total_count` | *int* | ✅ | Total number of workspaces | 5 | \ No newline at end of file +| `data` | List[[components.Workspace](../components/workspace.mdx)] | :heavy_check_mark: | List of workspaces | | +| `total_count` | *int* | :heavy_check_mark: | Total number of workspaces | 5 | \ No newline at end of file diff --git a/docs/components/localshellcallitem.mdx b/docs/components/localshellcallitem.mdx index 93382ae4a..c3ce8fe82 100644 --- a/docs/components/localshellcallitem.mdx +++ b/docs/components/localshellcallitem.mdx @@ -9,8 +9,8 @@ A local shell command execution call | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `action` | [components.LocalShellCallItemAction](../components/localshellcallitemaction.mdx) | ✅ | N/A | | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.TypeLocalShellCall](../components/typelocalshellcall.mdx) | ✅ | N/A | | \ No newline at end of file +| `action` | [components.LocalShellCallItemAction](../components/localshellcallitemaction.mdx) | :heavy_check_mark: | N/A | | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.TypeLocalShellCall](../components/typelocalshellcall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/localshellcallitemaction.mdx b/docs/components/localshellcallitemaction.mdx index 4f386bb68..584d53921 100644 --- a/docs/components/localshellcallitemaction.mdx +++ b/docs/components/localshellcallitemaction.mdx @@ -6,9 +6,9 @@ title: "LocalShellCallItemAction" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `command` | List[*str*] | ✅ | N/A | -| `env` | Dict[str, *str*] | ✅ | N/A | -| `timeout_ms` | *OptionalNullable[int]* | ➖ | N/A | -| `type` | [components.TypeExec](../components/typeexec.mdx) | ✅ | N/A | -| `user` | *OptionalNullable[str]* | ➖ | N/A | -| `working_directory` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file +| `command` | List[*str*] | :heavy_check_mark: | N/A | +| `env` | Dict[str, *str*] | :heavy_check_mark: | N/A | +| `timeout_ms` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | +| `type` | [components.TypeExec](../components/typeexec.mdx) | :heavy_check_mark: | N/A | +| `user` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `working_directory` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/localshellcalloutputitem.mdx b/docs/components/localshellcalloutputitem.mdx index a6ed03152..eff6d3493 100644 --- a/docs/components/localshellcalloutputitem.mdx +++ b/docs/components/localshellcalloutputitem.mdx @@ -9,7 +9,7 @@ Output from a local shell command execution | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | | -| `output` | *str* | ✅ | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | -| `type` | [components.LocalShellCallOutputItemType](../components/localshellcalloutputitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | N/A | | +| `output` | *str* | :heavy_check_mark: | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | +| `type` | [components.LocalShellCallOutputItemType](../components/localshellcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/logprob.mdx b/docs/components/logprob.mdx index 18d71fff1..6345da5c5 100644 --- a/docs/components/logprob.mdx +++ b/docs/components/logprob.mdx @@ -6,7 +6,7 @@ title: "Logprob" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `bytes_` | List[*int*] | ✅ | N/A | -| `logprob` | *float* | ✅ | N/A | -| `token` | *str* | ✅ | N/A | -| `top_logprobs` | List[[components.ResponseOutputTextTopLogprob](../components/responseoutputtexttoplogprob.mdx)] | ✅ | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | +| `logprob` | *float* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | +| `top_logprobs` | List[[components.ResponseOutputTextTopLogprob](../components/responseoutputtexttoplogprob.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/logprobs.mdx b/docs/components/logprobs.mdx index 2b9725648..c0b2da9f7 100644 --- a/docs/components/logprobs.mdx +++ b/docs/components/logprobs.mdx @@ -6,5 +6,5 @@ title: "Logprobs" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `content` | List[[components.LogprobsContent](../components/logprobscontent.mdx)] | ✅ | N/A | -| `refusal` | List[[components.Refusal](../components/refusal.mdx)] | ➖ | N/A | \ No newline at end of file +| `content` | List[[components.LogprobsContent](../components/logprobscontent.mdx)] | :heavy_check_mark: | N/A | +| `refusal` | List[[components.Refusal](../components/refusal.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/logprobscontent.mdx b/docs/components/logprobscontent.mdx index bce4cf6f8..0645e0cdd 100644 --- a/docs/components/logprobscontent.mdx +++ b/docs/components/logprobscontent.mdx @@ -6,7 +6,7 @@ title: "LogprobsContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | ✅ | N/A | -| `logprob` | *float* | ✅ | N/A | -| `token` | *str* | ✅ | N/A | -| `top_logprobs` | List[[components.ContentTopLogprob](../components/contenttoplogprob.mdx)] | ✅ | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | +| `logprob` | *float* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | +| `top_logprobs` | List[[components.ContentTopLogprob](../components/contenttoplogprob.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/managedprivateendpoint.mdx b/docs/components/managedprivateendpoint.mdx index 384f5ea97..31440c7b7 100644 --- a/docs/components/managedprivateendpoint.mdx +++ b/docs/components/managedprivateendpoint.mdx @@ -6,12 +6,12 @@ title: "ManagedPrivateEndpoint" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `model_name` | *Nullable[str]* | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `model_slug` | *Nullable[str]* | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `provider_name` | *str* | ✅ | Display name of the upstream provider. | Azure | -| `status` | [components.PrivateEndpointStatus](../components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | -| `declared_region` | [Nullable[components.PrivateEndpointDeclaredRegion]](../components/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `declared_zdr` | *Nullable[bool]* | ✅ | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | \ No newline at end of file +| `created_at` | *str* | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `model_name` | *Nullable[str]* | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `model_slug` | *Nullable[str]* | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `provider_name` | *str* | :heavy_check_mark: | Display name of the upstream provider. | Azure | +| `status` | [components.PrivateEndpointStatus](../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 | +| `declared_region` | [Nullable[components.PrivateEndpointDeclaredRegion]](../components/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `declared_zdr` | *Nullable[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/components/managedprivateendpointresponse.mdx b/docs/components/managedprivateendpointresponse.mdx index 585a2cdc3..f14bc4a6c 100644 --- a/docs/components/managedprivateendpointresponse.mdx +++ b/docs/components/managedprivateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "ManagedPrivateEndpointResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `data` | [components.ManagedPrivateEndpoint](../components/managedprivateendpoint.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.ManagedPrivateEndpoint](../components/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/match.mdx b/docs/components/match.mdx index 05119d7c4..c6bb3ad84 100644 --- a/docs/components/match.mdx +++ b/docs/components/match.mdx @@ -6,6 +6,6 @@ title: "Match" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `definition` | Dict[str, *Any*] | ✅ | N/A | -| `schema_digest` | *str* | ✅ | N/A | -| `tool_id` | *str* | ✅ | N/A | \ No newline at end of file +| `definition` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `schema_digest` | *str* | :heavy_check_mark: | N/A | +| `tool_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/maxprice.mdx b/docs/components/maxprice.mdx index 2e70934f4..e1892e259 100644 --- a/docs/components/maxprice.mdx +++ b/docs/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` | *Optional[str]* | ➖ | Maximum price in USD per audio unit | -| `completion` | *Optional[str]* | ➖ | Maximum price in USD per million completion tokens | -| `image` | *Optional[str]* | ➖ | Maximum price in USD per image | -| `prompt` | *Optional[str]* | ➖ | Maximum price in USD per million prompt tokens | -| `request` | *Optional[str]* | ➖ | Maximum price in USD per request | \ No newline at end of file +| `audio` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per audio unit | +| `completion` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per million completion tokens | +| `image` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per image | +| `prompt` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per million prompt tokens | +| `request` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per request | \ No newline at end of file diff --git a/docs/components/mcpapprovalrequestitem.mdx b/docs/components/mcpapprovalrequestitem.mdx index 3fd987097..d02d66656 100644 --- a/docs/components/mcpapprovalrequestitem.mdx +++ b/docs/components/mcpapprovalrequestitem.mdx @@ -9,8 +9,8 @@ Request for approval to execute an MCP tool | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `arguments` | *str* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `name` | *str* | ✅ | N/A | -| `server_label` | *str* | ✅ | N/A | -| `type` | [components.McpApprovalRequestItemType](../components/mcpapprovalrequestitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `server_label` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.McpApprovalRequestItemType](../components/mcpapprovalrequestitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/mcpapprovalresponseitem.mdx b/docs/components/mcpapprovalresponseitem.mdx index dda41b5c7..d67c1e405 100644 --- a/docs/components/mcpapprovalresponseitem.mdx +++ b/docs/components/mcpapprovalresponseitem.mdx @@ -9,8 +9,8 @@ User response to an MCP tool approval request | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `approval_request_id` | *str* | ✅ | N/A | -| `approve` | *bool* | ✅ | N/A | -| `id` | *OptionalNullable[str]* | ➖ | N/A | -| `reason` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.McpApprovalResponseItemType](../components/mcpapprovalresponseitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `approval_request_id` | *str* | :heavy_check_mark: | N/A | +| `approve` | *bool* | :heavy_check_mark: | N/A | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `reason` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.McpApprovalResponseItemType](../components/mcpapprovalresponseitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/mcpcallitem.mdx b/docs/components/mcpcallitem.mdx index c79ed0adf..3c63a3b9e 100644 --- a/docs/components/mcpcallitem.mdx +++ b/docs/components/mcpcallitem.mdx @@ -9,10 +9,10 @@ An MCP tool call with its output or error | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `arguments` | *str* | ✅ | N/A | | -| `error` | [OptionalNullable[components.McpToolCallError]](../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` | *str* | ✅ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `output` | *OptionalNullable[str]* | ➖ | N/A | | -| `server_label` | *str* | ✅ | N/A | | -| `type` | [components.McpCallItemType](../components/mcpcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | | +| `error` | [OptionalNullable[components.McpToolCallError]](../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` | *str* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `output` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `server_label` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.McpCallItemType](../components/mcpcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/mcphttperror.mdx b/docs/components/mcphttperror.mdx index 5fe8945e6..5f845e652 100644 --- a/docs/components/mcphttperror.mdx +++ b/docs/components/mcphttperror.mdx @@ -9,6 +9,6 @@ The MCP server request failed at the HTTP layer | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `type` | [components.McpHTTPErrorType](../components/mcphttperrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.McpHTTPErrorType](../components/mcphttperrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/mcplisttoolsitem.mdx b/docs/components/mcplisttoolsitem.mdx index f2865a837..decba2cc8 100644 --- a/docs/components/mcplisttoolsitem.mdx +++ b/docs/components/mcplisttoolsitem.mdx @@ -9,8 +9,8 @@ List of available MCP tools from a server | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `error` | *OptionalNullable[str]* | ➖ | N/A | -| `id` | *str* | ✅ | N/A | -| `server_label` | *str* | ✅ | N/A | -| `tools` | List[[components.McpListToolsItemTool](../components/mcplisttoolsitemtool.mdx)] | ✅ | N/A | -| `type` | [components.McpListToolsItemType](../components/mcplisttoolsitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `error` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `server_label` | *str* | :heavy_check_mark: | N/A | +| `tools` | List[[components.McpListToolsItemTool](../components/mcplisttoolsitemtool.mdx)] | :heavy_check_mark: | N/A | +| `type` | [components.McpListToolsItemType](../components/mcplisttoolsitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/mcplisttoolsitemtool.mdx b/docs/components/mcplisttoolsitemtool.mdx index 8997f1c7a..b36fb7dc0 100644 --- a/docs/components/mcplisttoolsitemtool.mdx +++ b/docs/components/mcplisttoolsitemtool.mdx @@ -6,7 +6,7 @@ title: "McpListToolsItemTool" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `annotations` | *Optional[Any]* | ➖ | N/A | -| `description` | *OptionalNullable[str]* | ➖ | N/A | -| `input_schema` | Dict[str, *Any*] | ✅ | N/A | -| `name` | *str* | ✅ | N/A | \ No newline at end of file +| `annotations` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `input_schema` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/mcpprotocolerror.mdx b/docs/components/mcpprotocolerror.mdx index 73c54663a..9f3acaccd 100644 --- a/docs/components/mcpprotocolerror.mdx +++ b/docs/components/mcpprotocolerror.mdx @@ -9,6 +9,6 @@ The MCP server returned a protocol-level error | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `type` | [components.McpProtocolErrorType](../components/mcpprotocolerrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.McpProtocolErrorType](../components/mcpprotocolerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/mcpservertool.mdx b/docs/components/mcpservertool.mdx index be92ba849..70f051981 100644 --- a/docs/components/mcpservertool.mdx +++ b/docs/components/mcpservertool.mdx @@ -9,12 +9,12 @@ MCP (Model Context Protocol) tool configuration | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `allowed_tools` | [OptionalNullable[components.AllowedToolsUnion]](../components/allowedtoolsunion.mdx) | ➖ | N/A | -| `authorization` | *Optional[str]* | ➖ | N/A | -| `connector_id` | [Optional[components.ConnectorID]](../components/connectorid.mdx) | ➖ | N/A | -| `headers` | Dict[str, *str*] | ➖ | N/A | -| `require_approval` | [OptionalNullable[components.RequireApprovalUnion]](../components/requireapprovalunion.mdx) | ➖ | N/A | -| `server_description` | *Optional[str]* | ➖ | N/A | -| `server_label` | *str* | ✅ | N/A | -| `server_url` | *Optional[str]* | ➖ | N/A | -| `type` | [components.McpServerToolType](../components/mcpservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `allowed_tools` | [OptionalNullable[components.AllowedToolsUnion]](../components/allowedtoolsunion.mdx) | :heavy_minus_sign: | N/A | +| `authorization` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `connector_id` | [Optional[components.ConnectorID]](../components/connectorid.mdx) | :heavy_minus_sign: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | N/A | +| `require_approval` | [OptionalNullable[components.RequireApprovalUnion]](../components/requireapprovalunion.mdx) | :heavy_minus_sign: | N/A | +| `server_description` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `server_label` | *str* | :heavy_check_mark: | N/A | +| `server_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.McpServerToolType](../components/mcpservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/mcptoolexecutionerror.mdx b/docs/components/mcptoolexecutionerror.mdx index 195ca1bdc..6a11b52b9 100644 --- a/docs/components/mcptoolexecutionerror.mdx +++ b/docs/components/mcptoolexecutionerror.mdx @@ -9,5 +9,5 @@ The MCP tool ran but reported a failure | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `content` | *Optional[Any]* | ➖ | N/A | -| `type` | [components.McpToolExecutionErrorType](../components/mcptoolexecutionerrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `type` | [components.McpToolExecutionErrorType](../components/mcptoolexecutionerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/memberassignment.mdx b/docs/components/memberassignment.mdx index 5ca7f4d1b..589bcb61c 100644 --- a/docs/components/memberassignment.mdx +++ b/docs/components/memberassignment.mdx @@ -6,9 +6,9 @@ title: "MemberAssignment" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `assigned_by` | *Nullable[str]* | ✅ | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrail_id` | *str* | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *str* | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `organization_id` | *str* | ✅ | Organization ID | org_xyz789 | -| `user_id` | *str* | ✅ | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file +| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `organization_id` | *str* | :heavy_check_mark: | Organization ID | org_xyz789 | +| `user_id` | *str* | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file diff --git a/docs/components/message.mdx b/docs/components/message.mdx index d582933aa..293ccd909 100644 --- a/docs/components/message.mdx +++ b/docs/components/message.mdx @@ -6,11 +6,11 @@ title: "Message" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `annotations` | List[[components.Annotation](../components/annotation.mdx)] | ➖ | N/A | -| `content` | *Nullable[str]* | ✅ | N/A | -| `images` | List[[components.Image](../components/image.mdx)] | ➖ | N/A | -| `reasoning` | *OptionalNullable[str]* | ➖ | N/A | -| `reasoning_details` | List[[Nullable[components.ReasoningDetail]](../components/reasoningdetail.mdx)] | ➖ | N/A | -| `refusal` | *Nullable[str]* | ✅ | N/A | -| `role` | [components.ChoiceRole](../components/choicerole.mdx) | ✅ | N/A | -| `tool_calls` | List[[components.ToolCall](../components/toolcall.mdx)] | ➖ | N/A | \ No newline at end of file +| `annotations` | List[[components.Annotation](../components/annotation.mdx)] | :heavy_minus_sign: | N/A | +| `content` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `images` | List[[components.Image](../components/image.mdx)] | :heavy_minus_sign: | N/A | +| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `reasoning_details` | List[[Nullable[components.ReasoningDetail]](../components/reasoningdetail.mdx)] | :heavy_minus_sign: | N/A | +| `refusal` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `role` | [components.ChoiceRole](../components/choicerole.mdx) | :heavy_check_mark: | N/A | +| `tool_calls` | List[[components.ToolCall](../components/toolcall.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/messagesadvisortoolresultblock.mdx b/docs/components/messagesadvisortoolresultblock.mdx index 67193439a..8ae2160d7 100644 --- a/docs/components/messagesadvisortoolresultblock.mdx +++ b/docs/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` | Dict[str, *Any*] | ✅ | N/A | -| `tool_use_id` | *str* | ✅ | N/A | -| `type` | [components.MessagesAdvisorToolResultBlockType](../components/messagesadvisortoolresultblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesAdvisorToolResultBlockType](../components/messagesadvisortoolresultblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagesbashtoolresultblock.mdx b/docs/components/messagesbashtoolresultblock.mdx index 70c76d061..cf49493d9 100644 --- a/docs/components/messagesbashtoolresultblock.mdx +++ b/docs/components/messagesbashtoolresultblock.mdx @@ -9,8 +9,8 @@ Output of a sandbox-executed `openrouter:bash` call from a prior assistant turn. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *Optional[str]* | ➖ | 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` | Dict[str, *Any*] | ✅ | N/A | -| `files` | List[[components.MessagesBashToolResultBlockFile](../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. | -| `tool_use_id` | *str* | ✅ | N/A | -| `type` | [components.MessagesBashToolResultBlockTypeOpenrouterBashToolResult](../components/messagesbashtoolresultblocktypeopenrouterbashtoolresult.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *Optional[str]* | :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` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `files` | List[[components.MessagesBashToolResultBlockFile](../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. | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesBashToolResultBlockTypeOpenrouterBashToolResult](../components/messagesbashtoolresultblocktypeopenrouterbashtoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagesbashtoolresultblockfile.mdx b/docs/components/messagesbashtoolresultblockfile.mdx index 1e8069a1c..74a698936 100644 --- a/docs/components/messagesbashtoolresultblockfile.mdx +++ b/docs/components/messagesbashtoolresultblockfile.mdx @@ -6,9 +6,9 @@ title: "MessagesBashToolResultBlockFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | ✅ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `file_id` | *str* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `type` | [components.MessagesBashToolResultBlockTypeContainerFileCitation](../components/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *str* | :heavy_check_mark: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesBashToolResultBlockTypeContainerFileCitation](../components/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagesfallbackparam.mdx b/docs/components/messagesfallbackparam.mdx index 012492726..a6a32a1a5 100644 --- a/docs/components/messagesfallbackparam.mdx +++ b/docs/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` | *str* | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file +| `model` | *str* | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file diff --git a/docs/components/messagesmessageparam.mdx b/docs/components/messagesmessageparam.mdx index e32cd7515..26c3fa025 100644 --- a/docs/components/messagesmessageparam.mdx +++ b/docs/components/messagesmessageparam.mdx @@ -9,7 +9,7 @@ Anthropic message with OpenRouter extensions | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `clear_at` | [OptionalNullable[components.AnthropicSystemClearAt]](../components/anthropicsystemclearat.mdx) | ➖ | N/A | next_user_message | -| `content` | [components.MessagesMessageParamContentUnion5](../components/messagesmessageparamcontentunion5.mdx) | ✅ | N/A | | -| `output_config` | [OptionalNullable[components.AnthropicMessageOutputConfig]](../components/anthropicmessageoutputconfig.mdx) | ➖ | N/A | \{
"effort": "low"
} | -| `role` | [components.MessagesMessageParamRole](../components/messagesmessageparamrole.mdx) | ✅ | N/A | | \ No newline at end of file +| `clear_at` | [OptionalNullable[components.AnthropicSystemClearAt]](../components/anthropicsystemclearat.mdx) | :heavy_minus_sign: | N/A | next_user_message | +| `content` | [components.MessagesMessageParamContentUnion5](../components/messagesmessageparamcontentunion5.mdx) | :heavy_check_mark: | N/A | | +| `output_config` | [OptionalNullable[components.AnthropicMessageOutputConfig]](../components/anthropicmessageoutputconfig.mdx) | :heavy_minus_sign: | N/A | \{
"effort": "low"
} | +| `role` | [components.MessagesMessageParamRole](../components/messagesmessageparamrole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/messagesoutputconfig.mdx b/docs/components/messagesoutputconfig.mdx index 62aac47ba..b5ce8e911 100644 --- a/docs/components/messagesoutputconfig.mdx +++ b/docs/components/messagesoutputconfig.mdx @@ -9,6 +9,6 @@ Configuration for controlling output behavior. Supports the effort parameter and | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.MessagesOutputConfigEffort]](../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[components.MessagesOutputConfigFormat]](../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). | | -| `task_budget` | [OptionalNullable[components.TaskBudget]](../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[components.MessagesOutputConfigEffort]](../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[components.MessagesOutputConfigFormat]](../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). | | +| `task_budget` | [OptionalNullable[components.TaskBudget]](../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/components/messagesoutputconfigformat.mdx b/docs/components/messagesoutputconfigformat.mdx index 4176103d2..cf56b3030 100644 --- a/docs/components/messagesoutputconfigformat.mdx +++ b/docs/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_` | Dict[str, *Any*] | ✅ | N/A | -| `type` | [components.MessagesOutputConfigTypeJSONSchema](../components/messagesoutputconfigtypejsonschema.mdx) | ✅ | N/A | \ No newline at end of file +| `schema_` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `type` | [components.MessagesOutputConfigTypeJSONSchema](../components/messagesoutputconfigtypejsonschema.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagesrequest.mdx b/docs/components/messagesrequest.mdx index 1049209ba..112001bf6 100644 --- a/docs/components/messagesrequest.mdx +++ b/docs/components/messagesrequest.mdx @@ -9,31 +9,31 @@ Request schema for Anthropic Messages API endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `context_management` | [OptionalNullable[components.ContextManagement]](../components/contextmanagement.mdx) | ➖ | N/A | | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `fallbacks` | List[[components.MessagesFallbackParam](../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"
}
] | -| `max_tokens` | *Optional[int]* | ➖ | N/A | | -| `messages` | List[[components.MessagesMessageParam](../components/messagesmessageparam.mdx)] | ✅ | N/A | | -| `metadata` | [Optional[components.MessagesRequestMetadata]](../components/messagesrequestmetadata.mdx) | ➖ | N/A | | -| `model` | *str* | ✅ | N/A | | -| `models` | List[*str*] | ➖ | N/A | | -| `output_config` | [Optional[components.MessagesOutputConfig]](../components/messagesoutputconfig.mdx) | ➖ | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | -| `plugins` | List[[components.MessagesRequestPlugin](../components/messagesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `safeguards` | List[[components.AnthropicSafeguard](../components/anthropicsafeguard.mdx)] | ➖ | N/A | | -| `service_tier` | *Optional[str]* | ➖ | N/A | | -| `session_id` | *Optional[str]* | ➖ | 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[components.Speed]](../components/speed.mdx) | ➖ | N/A | fast | -| `stop_sequences` | List[*str*] | ➖ | N/A | | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[bool]* | ➖ | N/A | | -| `system` | [Optional[components.System]](../components/system.mdx) | ➖ | N/A | | -| `temperature` | *Optional[float]* | ➖ | N/A | | -| `thinking` | [Optional[components.Thinking]](../components/thinking.mdx) | ➖ | N/A | | -| `tool_choice` | [Optional[components.ToolChoice]](../components/toolchoice.mdx) | ➖ | N/A | | -| `tools` | List[[components.MessagesRequestToolUnion](../components/messagesrequesttoolunion.mdx)] | ➖ | N/A | | -| `top_k` | *Optional[int]* | ➖ | N/A | | -| `top_p` | *Optional[float]* | ➖ | N/A | | -| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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 +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `context_management` | [OptionalNullable[components.ContextManagement]](../components/contextmanagement.mdx) | :heavy_minus_sign: | N/A | | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `fallbacks` | List[[components.MessagesFallbackParam](../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"
}
] | +| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `messages` | List[[components.MessagesMessageParam](../components/messagesmessageparam.mdx)] | :heavy_check_mark: | N/A | | +| `metadata` | [Optional[components.MessagesRequestMetadata]](../components/messagesrequestmetadata.mdx) | :heavy_minus_sign: | N/A | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `models` | List[*str*] | :heavy_minus_sign: | N/A | | +| `output_config` | [Optional[components.MessagesOutputConfig]](../components/messagesoutputconfig.mdx) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | +| `plugins` | List[[components.MessagesRequestPlugin](../components/messagesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `safeguards` | List[[components.AnthropicSafeguard](../components/anthropicsafeguard.mdx)] | :heavy_minus_sign: | N/A | | +| `service_tier` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `session_id` | *Optional[str]* | :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[components.Speed]](../components/speed.mdx) | :heavy_minus_sign: | N/A | fast | +| `stop_sequences` | List[*str*] | :heavy_minus_sign: | N/A | | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `system` | [Optional[components.System]](../components/system.mdx) | :heavy_minus_sign: | N/A | | +| `temperature` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `thinking` | [Optional[components.Thinking]](../components/thinking.mdx) | :heavy_minus_sign: | N/A | | +| `tool_choice` | [Optional[components.ToolChoice]](../components/toolchoice.mdx) | :heavy_minus_sign: | N/A | | +| `tools` | List[[components.MessagesRequestToolUnion](../components/messagesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | +| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `top_p` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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/components/messagesrequestmetadata.mdx b/docs/components/messagesrequestmetadata.mdx index fd4842ebf..fb2a55630 100644 --- a/docs/components/messagesrequestmetadata.mdx +++ b/docs/components/messagesrequestmetadata.mdx @@ -6,4 +6,4 @@ title: "MessagesRequestMetadata" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/messagesrequesttool.mdx b/docs/components/messagesrequesttool.mdx index c16c1c899..d432bb08e 100644 --- a/docs/components/messagesrequesttool.mdx +++ b/docs/components/messagesrequesttool.mdx @@ -6,5 +6,5 @@ title: "MessagesRequestTool" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `type` | *str* | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/messagessearchmodelsservertool.mdx b/docs/components/messagessearchmodelsservertool.mdx index 74d09c305..e13f74e2a 100644 --- a/docs/components/messagessearchmodelsservertool.mdx +++ b/docs/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` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [components.MessagesSearchModelsServerToolType](../components/messagessearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [components.MessagesSearchModelsServerToolType](../components/messagessearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/messagesshelltoolresultblock.mdx b/docs/components/messagesshelltoolresultblock.mdx index f64863bbd..c078c4b3b 100644 --- a/docs/components/messagesshelltoolresultblock.mdx +++ b/docs/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 | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *Optional[str]* | ➖ | 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` | Dict[str, *Any*] | ✅ | N/A | -| `files` | List[[components.MessagesShellToolResultBlockFile](../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. | -| `tool_use_id` | *str* | ✅ | N/A | -| `type` | [components.MessagesShellToolResultBlockTypeOpenrouterShellToolResult](../components/messagesshelltoolresultblocktypeopenroutershelltoolresult.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *Optional[str]* | :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` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `files` | List[[components.MessagesShellToolResultBlockFile](../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. | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesShellToolResultBlockTypeOpenrouterShellToolResult](../components/messagesshelltoolresultblocktypeopenroutershelltoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagesshelltoolresultblockfile.mdx b/docs/components/messagesshelltoolresultblockfile.mdx index 7107ecf01..e659a859d 100644 --- a/docs/components/messagesshelltoolresultblockfile.mdx +++ b/docs/components/messagesshelltoolresultblockfile.mdx @@ -6,9 +6,9 @@ title: "MessagesShellToolResultBlockFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | ✅ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `file_id` | *str* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `type` | [components.MessagesShellToolResultBlockTypeContainerFileCitation](../components/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *str* | :heavy_check_mark: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesShellToolResultBlockTypeContainerFileCitation](../components/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagestooladditionblock.mdx b/docs/components/messagestooladditionblock.mdx index b9cf44fcb..5a532b3a3 100644 --- a/docs/components/messagestooladditionblock.mdx +++ b/docs/components/messagestooladditionblock.mdx @@ -9,6 +9,6 @@ Loads a previously deferred tool (declared in `tools` with `defer_loading: true` | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagestooladditionblocktoolunion.mdx) | ✅ | N/A | | -| `type` | [components.TypeToolAddition](../components/typetooladdition.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagestooladditionblocktoolunion.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.TypeToolAddition](../components/typetooladdition.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/messagestooladditionblocktoolmcptoolreference.mdx b/docs/components/messagestooladditionblocktoolmcptoolreference.mdx index 02c7a9aaa..8f35a41fc 100644 --- a/docs/components/messagestooladditionblocktoolmcptoolreference.mdx +++ b/docs/components/messagestooladditionblocktoolmcptoolreference.mdx @@ -6,6 +6,6 @@ title: "MessagesToolAdditionBlockToolMcpToolReference" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | ✅ | N/A | -| `server_name` | *str* | ✅ | N/A | -| `type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../components/messagestooladditionblocktypemcptoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `name` | *str* | :heavy_check_mark: | N/A | +| `server_name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../components/messagestooladditionblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagestooladditionblocktoolmcptoolsetreference.mdx b/docs/components/messagestooladditionblocktoolmcptoolsetreference.mdx index 4d630c506..807e31935 100644 --- a/docs/components/messagestooladditionblocktoolmcptoolsetreference.mdx +++ b/docs/components/messagestooladditionblocktoolmcptoolsetreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolAdditionBlockToolMcpToolsetReference" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `server_name` | *str* | ✅ | N/A | -| `type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../components/messagestooladditionblocktypemcptoolsetreference.mdx) | ✅ | N/A | \ No newline at end of file +| `server_name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../components/messagestooladditionblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagestooladditionblocktooltoolreference.mdx b/docs/components/messagestooladditionblocktooltoolreference.mdx index acc92ca61..f56ec1fdc 100644 --- a/docs/components/messagestooladditionblocktooltoolreference.mdx +++ b/docs/components/messagestooladditionblocktooltoolreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolAdditionBlockToolToolReference" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | ✅ | N/A | -| `type` | [components.MessagesToolAdditionBlockTypeToolReference](../components/messagestooladditionblocktypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesToolAdditionBlockTypeToolReference](../components/messagestooladditionblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagestoolremovalblock.mdx b/docs/components/messagestoolremovalblock.mdx index 9d9efbc04..a8f4a77b4 100644 --- a/docs/components/messagestoolremovalblock.mdx +++ b/docs/components/messagestoolremovalblock.mdx @@ -9,6 +9,6 @@ Removes a tool from the conversation mid-conversation without invalidating the p | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagestoolremovalblocktoolunion.mdx) | ✅ | N/A | | -| `type` | [components.TypeToolRemoval](../components/typetoolremoval.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagestoolremovalblocktoolunion.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.TypeToolRemoval](../components/typetoolremoval.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/messagestoolremovalblocktoolmcptoolreference.mdx b/docs/components/messagestoolremovalblocktoolmcptoolreference.mdx index 1a20715e6..63a22858d 100644 --- a/docs/components/messagestoolremovalblocktoolmcptoolreference.mdx +++ b/docs/components/messagestoolremovalblocktoolmcptoolreference.mdx @@ -6,6 +6,6 @@ title: "MessagesToolRemovalBlockToolMcpToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `name` | *str* | ✅ | N/A | -| `server_name` | *str* | ✅ | N/A | -| `type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../components/messagestoolremovalblocktypemcptoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `name` | *str* | :heavy_check_mark: | N/A | +| `server_name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../components/messagestoolremovalblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagestoolremovalblocktoolmcptoolsetreference.mdx b/docs/components/messagestoolremovalblocktoolmcptoolsetreference.mdx index ffa9ce1a9..39ce3ffdf 100644 --- a/docs/components/messagestoolremovalblocktoolmcptoolsetreference.mdx +++ b/docs/components/messagestoolremovalblocktoolmcptoolsetreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolRemovalBlockToolMcpToolsetReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `server_name` | *str* | ✅ | N/A | -| `type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../components/messagestoolremovalblocktypemcptoolsetreference.mdx) | ✅ | N/A | \ No newline at end of file +| `server_name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../components/messagestoolremovalblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/messagestoolremovalblocktooltoolreference.mdx b/docs/components/messagestoolremovalblocktooltoolreference.mdx index e6700109f..5700e11ae 100644 --- a/docs/components/messagestoolremovalblocktooltoolreference.mdx +++ b/docs/components/messagestoolremovalblocktooltoolreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolRemovalBlockToolToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `name` | *str* | ✅ | N/A | -| `type` | [components.MessagesToolRemovalBlockTypeToolReference](../components/messagestoolremovalblocktypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.MessagesToolRemovalBlockTypeToolReference](../components/messagestoolremovalblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/mismatchbehavior.mdx b/docs/components/mismatchbehavior.mdx index b4a81493c..4082d3af8 100644 --- a/docs/components/mismatchbehavior.mdx +++ b/docs/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/components/model.mdx b/docs/components/model.mdx index 7901feacb..43e26adf5 100644 --- a/docs/components/model.mdx +++ b/docs/components/model.mdx @@ -9,23 +9,23 @@ Information about an AI model available on OpenRouter | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alias_target` | [Optional[components.ModelAliasTarget]](../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](../components/modelarchitecture.mdx) | ✅ | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `benchmarks` | [Optional[components.ModelBenchmarks]](../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
}
]
} | -| `canonical_slug` | *str* | ✅ | Canonical slug for the model | openai/gpt-4 | -| `context_length` | *Nullable[int]* | ✅ | Maximum context length in tokens | 8192 | -| `created` | *int* | ✅ | Unix timestamp of when the model was created | 1692901234 | -| `default_parameters` | [Nullable[components.DefaultParameters]](../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` | *Optional[str]* | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `expiration_date` | *OptionalNullable[str]* | ➖ | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | -| `hugging_face_id` | *OptionalNullable[str]* | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *str* | ✅ | Unique identifier for the model | openai/gpt-4 | -| `knowledge_cutoff` | *OptionalNullable[str]* | ➖ | 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](../components/modellinks.mdx) | ✅ | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | -| `name` | *str* | ✅ | Display name of the model | GPT-4 | -| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.mdx) | ✅ | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | -| `pricing` | [components.PublicPricing](../components/publicpricing.mdx) | ✅ | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | -| `reasoning` | [Optional[components.ModelReasoning]](../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"
]
} | -| `supported_parameters` | List[[components.Parameter](../components/parameter.mdx)] | ✅ | List of supported parameters for this model | | -| `supported_voices` | List[*str*] | ✅ | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | -| `top_provider` | [components.TopProviderInfo](../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 +| `alias_target` | [Optional[components.ModelAliasTarget]](../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](../components/modelarchitecture.mdx) | :heavy_check_mark: | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `benchmarks` | [Optional[components.ModelBenchmarks]](../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
}
]
} | +| `canonical_slug` | *str* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | +| `context_length` | *Nullable[int]* | :heavy_check_mark: | Maximum context length in tokens | 8192 | +| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | +| `default_parameters` | [Nullable[components.DefaultParameters]](../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` | *Optional[str]* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `expiration_date` | *OptionalNullable[str]* | :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 | +| `hugging_face_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | +| `knowledge_cutoff` | *OptionalNullable[str]* | :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](../components/modellinks.mdx) | :heavy_check_mark: | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | +| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | +| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.mdx) | :heavy_check_mark: | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | +| `pricing` | [components.PublicPricing](../components/publicpricing.mdx) | :heavy_check_mark: | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | +| `reasoning` | [Optional[components.ModelReasoning]](../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"
]
} | +| `supported_parameters` | List[[components.Parameter](../components/parameter.mdx)] | :heavy_check_mark: | List of supported parameters for this model | | +| `supported_voices` | List[*str*] | :heavy_check_mark: | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | +| `top_provider` | [components.TopProviderInfo](../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/components/modelaliastarget.mdx b/docs/components/modelaliastarget.mdx index 176083da8..66d683bd2 100644 --- a/docs/components/modelaliastarget.mdx +++ b/docs/components/modelaliastarget.mdx @@ -9,5 +9,5 @@ Concrete model targeted by this tilde-latest alias, when applicable | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `name` | *str* | ✅ | Human-readable name of the concrete model targeted by this alias | -| `slug` | *str* | ✅ | Routable model ID of the concrete target, matching that model row's id | \ No newline at end of file +| `name` | *str* | :heavy_check_mark: | Human-readable name of the concrete model targeted by this alias | +| `slug` | *str* | :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/components/modelarchitecture.mdx b/docs/components/modelarchitecture.mdx index acbd961bf..d46fef469 100644 --- a/docs/components/modelarchitecture.mdx +++ b/docs/components/modelarchitecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `input_modalities` | List[[components.InputModality](../components/inputmodality.mdx)] | ✅ | Supported input modalities | | -| `instruct_type` | [OptionalNullable[components.InstructType]](../components/instructtype.mdx) | ➖ | Instruction format type | chatml | -| `modality` | *Nullable[str]* | ✅ | Primary modality of the model | text->text | -| `output_modalities` | List[[components.OutputModality](../components/outputmodality.mdx)] | ✅ | Supported output modalities | | -| `tokenizer` | [Optional[components.ModelGroup]](../components/modelgroup.mdx) | ➖ | Tokenizer type used by the model | GPT | \ No newline at end of file +| `input_modalities` | List[[components.InputModality](../components/inputmodality.mdx)] | :heavy_check_mark: | Supported input modalities | | +| `instruct_type` | [OptionalNullable[components.InstructType]](../components/instructtype.mdx) | :heavy_minus_sign: | Instruction format type | chatml | +| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text->text | +| `output_modalities` | List[[components.OutputModality](../components/outputmodality.mdx)] | :heavy_check_mark: | Supported output modalities | | +| `tokenizer` | [Optional[components.ModelGroup]](../components/modelgroup.mdx) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/docs/components/modelbenchmarks.mdx b/docs/components/modelbenchmarks.mdx index 526fec0fb..f9d4890de 100644 --- a/docs/components/modelbenchmarks.mdx +++ b/docs/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 | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `artificial_analysis` | [Optional[components.AABenchmarkEntry]](../components/aabenchmarkentry.mdx) | ➖ | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | -| `design_arena` | List[[components.DABenchmarkEntry](../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 +| `artificial_analysis` | [Optional[components.AABenchmarkEntry]](../components/aabenchmarkentry.mdx) | :heavy_minus_sign: | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | +| `design_arena` | List[[components.DABenchmarkEntry](../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/components/modellinks.mdx b/docs/components/modellinks.mdx index 5a4272b28..2a6259988 100644 --- a/docs/components/modellinks.mdx +++ b/docs/components/modellinks.mdx @@ -9,4 +9,4 @@ Related API endpoints and resources for this model. | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `details` | *str* | ✅ | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file +| `details` | *str* | :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/components/modelreasoning.mdx b/docs/components/modelreasoning.mdx index 000ea73e6..b8d23642d 100644 --- a/docs/components/modelreasoning.mdx +++ b/docs/components/modelreasoning.mdx @@ -9,8 +9,8 @@ Reasoning effort configuration. Omitted for non-reasoning models and dynamic rou | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `default_effort` | [OptionalNullable[components.DefaultEffort]](../components/defaulteffort.mdx) | ➖ | N/A | medium | -| `default_enabled` | *Optional[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. | | -| `supported_efforts` | List[[Nullable[components.ReasoningEffort]](../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. | | -| `supports_max_tokens` | *Optional[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 +| `default_effort` | [OptionalNullable[components.DefaultEffort]](../components/defaulteffort.mdx) | :heavy_minus_sign: | N/A | medium | +| `default_enabled` | *Optional[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. | | +| `supported_efforts` | List[[Nullable[components.ReasoningEffort]](../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. | | +| `supports_max_tokens` | *Optional[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/components/modelresponse.mdx b/docs/components/modelresponse.mdx index 1c5bbde62..9ced33061 100644 --- a/docs/components/modelresponse.mdx +++ b/docs/components/modelresponse.mdx @@ -9,4 +9,4 @@ Single model response | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Model](../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](../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/components/modelscountresponse.mdx b/docs/components/modelscountresponse.mdx index ff98324e0..104a32fd7 100644 --- a/docs/components/modelscountresponse.mdx +++ b/docs/components/modelscountresponse.mdx @@ -9,4 +9,4 @@ Model count data | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | [components.ModelsCountResponseData](../components/modelscountresponsedata.mdx) | ✅ | Model count data | \{
"count": 150
} | \ No newline at end of file +| `data` | [components.ModelsCountResponseData](../components/modelscountresponsedata.mdx) | :heavy_check_mark: | Model count data | \{
"count": 150
} | \ No newline at end of file diff --git a/docs/components/modelscountresponsedata.mdx b/docs/components/modelscountresponsedata.mdx index 0cace4a6a..9e1b9145d 100644 --- a/docs/components/modelscountresponsedata.mdx +++ b/docs/components/modelscountresponsedata.mdx @@ -9,4 +9,4 @@ Model count data | Field | Type | Required | Description | Example | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `count` | *int* | ✅ | Total number of available models | 150 | \ No newline at end of file +| `count` | *int* | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file diff --git a/docs/components/modelslistresponse.mdx b/docs/components/modelslistresponse.mdx index 9e9ab4cd5..505a1c073 100644 --- a/docs/components/modelslistresponse.mdx +++ b/docs/components/modelslistresponse.mdx @@ -9,6 +9,6 @@ List of available models | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.Model](../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](../components/modelslistresponselinks.mdx) | ✅ | Pagination links | | -| `total_count` | *int* | ✅ | Total number of models matching the query | 150 | \ No newline at end of file +| `data` | List[[components.Model](../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](../components/modelslistresponselinks.mdx) | :heavy_check_mark: | Pagination links | | +| `total_count` | *int* | :heavy_check_mark: | Total number of models matching the query | 150 | \ No newline at end of file diff --git a/docs/components/modelslistresponselinks.mdx b/docs/components/modelslistresponselinks.mdx index 4b24a85e3..4c3a50213 100644 --- a/docs/components/modelslistresponselinks.mdx +++ b/docs/components/modelslistresponselinks.mdx @@ -9,4 +9,4 @@ Pagination links | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `next` | *Nullable[str]* | ✅ | 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` | *Nullable[str]* | :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/components/moderationplugin.mdx b/docs/components/moderationplugin.mdx index 5a075c416..0fd2af65a 100644 --- a/docs/components/moderationplugin.mdx +++ b/docs/components/moderationplugin.mdx @@ -6,4 +6,4 @@ title: "ModerationPlugin" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `id` | [components.ModerationPluginID](../components/moderationpluginid.mdx) | ✅ | N/A | \ No newline at end of file +| `id` | [components.ModerationPluginID](../components/moderationpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/multimodalmedia.mdx b/docs/components/multimodalmedia.mdx index 72ae5e60d..9b621c1cc 100644 --- a/docs/components/multimodalmedia.mdx +++ b/docs/components/multimodalmedia.mdx @@ -6,5 +6,5 @@ title: "MultimodalMedia" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `data` | *str* | ✅ | N/A | -| `format_` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `data` | *str* | :heavy_check_mark: | N/A | +| `format_` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/namespacefunctiontool.mdx b/docs/components/namespacefunctiontool.mdx index c58d9d82f..3fea9cdfb 100644 --- a/docs/components/namespacefunctiontool.mdx +++ b/docs/components/namespacefunctiontool.mdx @@ -9,12 +9,12 @@ A function tool grouped inside a namespace tool | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_callers` | List[[components.NamespaceFunctionToolAllowedCaller](../components/namespacefunctiontoolallowedcaller.mdx)] | ➖ | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | ➖ | N/A | | -| `description` | *OptionalNullable[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | -| `parameters` | Dict[str, *Any*] | ➖ | N/A | | -| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | -| `type` | [components.NamespaceFunctionToolType](../components/namespacefunctiontooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `allowed_callers` | List[[components.NamespaceFunctionToolAllowedCaller](../components/namespacefunctiontoolallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `type` | [components.NamespaceFunctionToolType](../components/namespacefunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/namespacetool.mdx b/docs/components/namespacetool.mdx index d00413cfe..fab5a7cce 100644 --- a/docs/components/namespacetool.mdx +++ b/docs/components/namespacetool.mdx @@ -9,7 +9,7 @@ Groups function/custom tools under a shared namespace | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `description` | *str* | ✅ | N/A | -| `name` | *str* | ✅ | N/A | -| `tools` | List[[components.NamespaceToolTool](../components/namespacetooltool.mdx)] | ✅ | N/A | -| `type` | [components.NamespaceToolType](../components/namespacetooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `description` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `tools` | List[[components.NamespaceToolTool](../components/namespacetooltool.mdx)] | :heavy_check_mark: | N/A | +| `type` | [components.NamespaceToolType](../components/namespacetooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/nativesupport.mdx b/docs/components/nativesupport.mdx index 57e8500c7..a45fc5f12 100644 --- a/docs/components/nativesupport.mdx +++ b/docs/components/nativesupport.mdx @@ -9,6 +9,6 @@ Endpoints whose provider runs this tool itself during inference. Zero for tools | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `endpoint_count` | *int* | ✅ | N/A | 18 | -| `model_count` | *int* | ✅ | N/A | 12 | -| `models` | List[[components.ServerToolNativeModel](../components/servertoolnativemodel.mdx)] | ✅ | N/A | | \ No newline at end of file +| `endpoint_count` | *int* | :heavy_check_mark: | N/A | 18 | +| `model_count` | *int* | :heavy_check_mark: | N/A | 12 | +| `models` | List[[components.ServerToolNativeModel](../components/servertoolnativemodel.mdx)] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/nativetools.mdx b/docs/components/nativetools.mdx index 57c9b4dd1..f578f85cd 100644 --- a/docs/components/nativetools.mdx +++ b/docs/components/nativetools.mdx @@ -6,4 +6,4 @@ title: "NativeTools" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *str* | ✅ | 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` | *str* | :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/components/never.mdx b/docs/components/never.mdx index 41a96792c..37ce7d365 100644 --- a/docs/components/never.mdx +++ b/docs/components/never.mdx @@ -6,4 +6,4 @@ title: "Never" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `tool_names` | List[*str*] | ➖ | N/A | \ No newline at end of file +| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/notfoundresponseerrordata.mdx b/docs/components/notfoundresponseerrordata.mdx index e564eb88e..e0bc365ca 100644 --- a/docs/components/notfoundresponseerrordata.mdx +++ b/docs/components/notfoundresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for NotFoundResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/oauthjwks.mdx b/docs/components/oauthjwks.mdx index 2c6972233..463ee9cd6 100644 --- a/docs/components/oauthjwks.mdx +++ b/docs/components/oauthjwks.mdx @@ -9,4 +9,4 @@ RFC 7517 JWK Set of the keys OpenRouter signs access tokens with. | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `keys` | List[[components.Key](../components/key.mdx)] | ✅ | N/A | \ No newline at end of file +| `keys` | List[[components.Key](../components/key.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilityarizedestination.mdx b/docs/components/observabilityarizedestination.mdx index 16ad5585d..81b38c7eb 100644 --- a/docs/components/observabilityarizedestination.mdx +++ b/docs/components/observabilityarizedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityArizeDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityArizeDestinationConfig](../components/observabilityarizedestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityArizeDestinationType](../components/observabilityarizedestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityArizeDestinationConfig](../components/observabilityarizedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityArizeDestinationType](../components/observabilityarizedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilityarizedestinationconfig.mdx b/docs/components/observabilityarizedestinationconfig.mdx index e4a03087d..9a4f66bee 100644 --- a/docs/components/observabilityarizedestinationconfig.mdx +++ b/docs/components/observabilityarizedestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityArizeDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | ✅ | N/A | -| `base_url` | *Optional[str]* | ➖ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `model_id` | *str* | ✅ | The name of the tracing project in Arize AX | -| `space_key` | *str* | ✅ | N/A | \ No newline at end of file +| `api_key` | *str* | :heavy_check_mark: | N/A | +| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `model_id` | *str* | :heavy_check_mark: | The name of the tracing project in Arize AX | +| `space_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilitybraintrustdestination.mdx b/docs/components/observabilitybraintrustdestination.mdx index f10debe55..de01be166 100644 --- a/docs/components/observabilitybraintrustdestination.mdx +++ b/docs/components/observabilitybraintrustdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityBraintrustDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityBraintrustDestinationConfig](../components/observabilitybraintrustdestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityBraintrustDestinationType](../components/observabilitybraintrustdestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityBraintrustDestinationConfig](../components/observabilitybraintrustdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityBraintrustDestinationType](../components/observabilitybraintrustdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitybraintrustdestinationconfig.mdx b/docs/components/observabilitybraintrustdestinationconfig.mdx index 0e4d24b7e..56fcb6232 100644 --- a/docs/components/observabilitybraintrustdestinationconfig.mdx +++ b/docs/components/observabilitybraintrustdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityBraintrustDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | ✅ | N/A | -| `base_url` | *Optional[str]* | ➖ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `project_id` | *str* | ✅ | N/A | \ No newline at end of file +| `api_key` | *str* | :heavy_check_mark: | N/A | +| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `project_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilityclickhousedestination.mdx b/docs/components/observabilityclickhousedestination.mdx index 3b810270a..d1aa02d0d 100644 --- a/docs/components/observabilityclickhousedestination.mdx +++ b/docs/components/observabilityclickhousedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityClickhouseDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityClickhouseDestinationConfig](../components/observabilityclickhousedestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityClickhouseDestinationType](../components/observabilityclickhousedestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityClickhouseDestinationConfig](../components/observabilityclickhousedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityClickhouseDestinationType](../components/observabilityclickhousedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilityclickhousedestinationconfig.mdx b/docs/components/observabilityclickhousedestinationconfig.mdx index 86a71c70f..1eac658c8 100644 --- a/docs/components/observabilityclickhousedestinationconfig.mdx +++ b/docs/components/observabilityclickhousedestinationconfig.mdx @@ -6,10 +6,10 @@ title: "ObservabilityClickhouseDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `database` | *str* | ✅ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `host` | *str* | ✅ | N/A | -| `password` | *str* | ✅ | N/A | -| `should_include_cache_write_tokens` | *Optional[bool]* | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `table` | *Optional[str]* | ➖ | N/A | -| `username` | *str* | ✅ | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file +| `database` | *str* | :heavy_check_mark: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `host` | *str* | :heavy_check_mark: | N/A | +| `password` | *str* | :heavy_check_mark: | N/A | +| `should_include_cache_write_tokens` | *Optional[bool]* | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `table` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `username` | *str* | :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/components/observabilitydatadogdestination.mdx b/docs/components/observabilitydatadogdestination.mdx index b13db94b2..72f0faa27 100644 --- a/docs/components/observabilitydatadogdestination.mdx +++ b/docs/components/observabilitydatadogdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityDatadogDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityDatadogDestinationConfig](../components/observabilitydatadogdestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityDatadogDestinationType](../components/observabilitydatadogdestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityDatadogDestinationConfig](../components/observabilitydatadogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityDatadogDestinationType](../components/observabilitydatadogdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitydatadogdestinationconfig.mdx b/docs/components/observabilitydatadogdestinationconfig.mdx index acee481b5..ed2b5c529 100644 --- a/docs/components/observabilitydatadogdestinationconfig.mdx +++ b/docs/components/observabilitydatadogdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityDatadogDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *str* | ✅ | Datadog API key must have LLM Observability permissions. Create at: | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `ml_app` | *str* | ✅ | Name to identify your application in Datadog LLM Observability | -| `url` | *Optional[str]* | ➖ | 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 +| `api_key` | *str* | :heavy_check_mark: | Datadog API key must have LLM Observability permissions. Create at: | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `ml_app` | *str* | :heavy_check_mark: | Name to identify your application in Datadog LLM Observability | +| `url` | *Optional[str]* | :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/components/observabilityfilterrulegroup.mdx b/docs/components/observabilityfilterrulegroup.mdx index bd9dc6dae..95aa7cfb8 100644 --- a/docs/components/observabilityfilterrulegroup.mdx +++ b/docs/components/observabilityfilterrulegroup.mdx @@ -6,5 +6,5 @@ title: "ObservabilityFilterRuleGroup" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `logic` | [Optional[components.Logic]](../components/logic.mdx) | ➖ | N/A | -| `rules` | List[[components.Rule](../components/rule.mdx)] | ✅ | N/A | \ No newline at end of file +| `logic` | [Optional[components.Logic]](../components/logic.mdx) | :heavy_minus_sign: | N/A | +| `rules` | List[[components.Rule](../components/rule.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilityfilterrulesconfig.mdx b/docs/components/observabilityfilterrulesconfig.mdx index c8676edbb..839340442 100644 --- a/docs/components/observabilityfilterrulesconfig.mdx +++ b/docs/components/observabilityfilterrulesconfig.mdx @@ -9,5 +9,5 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | ➖ | N/A | -| `groups` | List[[components.ObservabilityFilterRuleGroup](../components/observabilityfilterrulegroup.mdx)] | ✅ | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `groups` | List[[components.ObservabilityFilterRuleGroup](../components/observabilityfilterrulegroup.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilityfilterrulesconfignullable.mdx b/docs/components/observabilityfilterrulesconfignullable.mdx index d3f087caa..842fa8f78 100644 --- a/docs/components/observabilityfilterrulesconfignullable.mdx +++ b/docs/components/observabilityfilterrulesconfignullable.mdx @@ -9,5 +9,5 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | ➖ | N/A | -| `groups` | List[[components.ObservabilityFilterRuleGroup](../components/observabilityfilterrulegroup.mdx)] | ✅ | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `groups` | List[[components.ObservabilityFilterRuleGroup](../components/observabilityfilterrulegroup.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilitygrafanadestination.mdx b/docs/components/observabilitygrafanadestination.mdx index d2628a53e..74004a3f8 100644 --- a/docs/components/observabilitygrafanadestination.mdx +++ b/docs/components/observabilitygrafanadestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityGrafanaDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityGrafanaDestinationConfig](../components/observabilitygrafanadestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityGrafanaDestinationType](../components/observabilitygrafanadestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityGrafanaDestinationConfig](../components/observabilitygrafanadestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityGrafanaDestinationType](../components/observabilitygrafanadestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitygrafanadestinationconfig.mdx b/docs/components/observabilitygrafanadestinationconfig.mdx index 04e0fb4b0..34d561c25 100644 --- a/docs/components/observabilitygrafanadestinationconfig.mdx +++ b/docs/components/observabilitygrafanadestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityGrafanaDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | ✅ | N/A | -| `base_url` | *Optional[str]* | ➖ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `instance_id` | *str* | ✅ | N/A | \ No newline at end of file +| `api_key` | *str* | :heavy_check_mark: | N/A | +| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `instance_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilitylangfusedestination.mdx b/docs/components/observabilitylangfusedestination.mdx index 44a61473f..d3acd28ab 100644 --- a/docs/components/observabilitylangfusedestination.mdx +++ b/docs/components/observabilitylangfusedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityLangfuseDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityLangfuseDestinationConfig](../components/observabilitylangfusedestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityLangfuseDestinationType](../components/observabilitylangfusedestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityLangfuseDestinationConfig](../components/observabilitylangfusedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityLangfuseDestinationType](../components/observabilitylangfusedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitylangfusedestinationconfig.mdx b/docs/components/observabilitylangfusedestinationconfig.mdx index 359cd2576..cabadb292 100644 --- a/docs/components/observabilitylangfusedestinationconfig.mdx +++ b/docs/components/observabilitylangfusedestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityLangfuseDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `base_url` | *Optional[str]* | ➖ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `public_key` | *str* | ✅ | N/A | -| `secret_key` | *str* | ✅ | N/A | \ No newline at end of file +| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `public_key` | *str* | :heavy_check_mark: | N/A | +| `secret_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilitylangsmithdestination.mdx b/docs/components/observabilitylangsmithdestination.mdx index d12830836..a1fb2aaa0 100644 --- a/docs/components/observabilitylangsmithdestination.mdx +++ b/docs/components/observabilitylangsmithdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityLangsmithDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityLangsmithDestinationConfig](../components/observabilitylangsmithdestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityLangsmithDestinationType](../components/observabilitylangsmithdestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityLangsmithDestinationConfig](../components/observabilitylangsmithdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityLangsmithDestinationType](../components/observabilitylangsmithdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitylangsmithdestinationconfig.mdx b/docs/components/observabilitylangsmithdestinationconfig.mdx index 53bc63c7c..0a1f76e5a 100644 --- a/docs/components/observabilitylangsmithdestinationconfig.mdx +++ b/docs/components/observabilitylangsmithdestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityLangsmithDestinationConfig" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `api_key` | *str* | ✅ | N/A | -| `endpoint` | *Optional[str]* | ➖ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `project` | *Optional[str]* | ➖ | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | -| `workspace_id` | *Optional[str]* | ➖ | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file +| `api_key` | *str* | :heavy_check_mark: | N/A | +| `endpoint` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `project` | *Optional[str]* | :heavy_minus_sign: | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | +| `workspace_id` | *Optional[str]* | :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/components/observabilitynewrelicdestination.mdx b/docs/components/observabilitynewrelicdestination.mdx index c4a4ea6c5..0865859d0 100644 --- a/docs/components/observabilitynewrelicdestination.mdx +++ b/docs/components/observabilitynewrelicdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityNewrelicDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityNewrelicDestinationConfig](../components/observabilitynewrelicdestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityNewrelicDestinationType](../components/observabilitynewrelicdestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityNewrelicDestinationConfig](../components/observabilitynewrelicdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityNewrelicDestinationType](../components/observabilitynewrelicdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitynewrelicdestinationconfig.mdx b/docs/components/observabilitynewrelicdestinationconfig.mdx index 99688937f..eb8542dca 100644 --- a/docs/components/observabilitynewrelicdestinationconfig.mdx +++ b/docs/components/observabilitynewrelicdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityNewrelicDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `license_key` | *str* | ✅ | N/A | -| `region` | [Optional[components.Region]](../components/region.mdx) | ➖ | N/A | \ No newline at end of file +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `license_key` | *str* | :heavy_check_mark: | N/A | +| `region` | [Optional[components.Region]](../components/region.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/observabilityopikdestination.mdx b/docs/components/observabilityopikdestination.mdx index 7be32b1f7..31277388b 100644 --- a/docs/components/observabilityopikdestination.mdx +++ b/docs/components/observabilityopikdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityOpikDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityOpikDestinationConfig](../components/observabilityopikdestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityOpikDestinationType](../components/observabilityopikdestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityOpikDestinationConfig](../components/observabilityopikdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityOpikDestinationType](../components/observabilityopikdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilityopikdestinationconfig.mdx b/docs/components/observabilityopikdestinationconfig.mdx index 97f79e6b8..ce71d1f16 100644 --- a/docs/components/observabilityopikdestinationconfig.mdx +++ b/docs/components/observabilityopikdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityOpikDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | ✅ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `project_name` | *str* | ✅ | N/A | -| `workspace` | *str* | ✅ | N/A | \ No newline at end of file +| `api_key` | *str* | :heavy_check_mark: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `project_name` | *str* | :heavy_check_mark: | N/A | +| `workspace` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilityotelcollectordestination.mdx b/docs/components/observabilityotelcollectordestination.mdx index f4fec2071..3052cfc35 100644 --- a/docs/components/observabilityotelcollectordestination.mdx +++ b/docs/components/observabilityotelcollectordestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityOtelCollectorDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityOtelCollectorDestinationConfig](../components/observabilityotelcollectordestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityOtelCollectorDestinationType](../components/observabilityotelcollectordestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityOtelCollectorDestinationConfig](../components/observabilityotelcollectordestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityOtelCollectorDestinationType](../components/observabilityotelcollectordestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilityotelcollectordestinationconfig.mdx b/docs/components/observabilityotelcollectordestinationconfig.mdx index c625d1a95..c0e46e241 100644 --- a/docs/components/observabilityotelcollectordestinationconfig.mdx +++ b/docs/components/observabilityotelcollectordestinationconfig.mdx @@ -6,5 +6,5 @@ title: "ObservabilityOtelCollectorDestinationConfig" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `endpoint` | *str* | ✅ | N/A | -| `headers` | Dict[str, *str*] | ➖ | 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` | *str* | :heavy_check_mark: | N/A | +| `headers` | Dict[str, *str*] | :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/components/observabilityposthogdestination.mdx b/docs/components/observabilityposthogdestination.mdx index ce92982f5..0348a7d46 100644 --- a/docs/components/observabilityposthogdestination.mdx +++ b/docs/components/observabilityposthogdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityPosthogDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityPosthogDestinationConfig](../components/observabilityposthogdestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityPosthogDestinationType](../components/observabilityposthogdestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityPosthogDestinationConfig](../components/observabilityposthogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityPosthogDestinationType](../components/observabilityposthogdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilityposthogdestinationconfig.mdx b/docs/components/observabilityposthogdestinationconfig.mdx index 8ed1df6aa..2c0c48dee 100644 --- a/docs/components/observabilityposthogdestinationconfig.mdx +++ b/docs/components/observabilityposthogdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityPosthogDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | ✅ | N/A | -| `endpoint` | *Optional[str]* | ➖ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file +| `api_key` | *str* | :heavy_check_mark: | N/A | +| `endpoint` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file diff --git a/docs/components/observabilityrampdestination.mdx b/docs/components/observabilityrampdestination.mdx index 45565dc9d..43f146a50 100644 --- a/docs/components/observabilityrampdestination.mdx +++ b/docs/components/observabilityrampdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityRampDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityRampDestinationConfig](../components/observabilityrampdestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityRampDestinationType](../components/observabilityrampdestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityRampDestinationConfig](../components/observabilityrampdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityRampDestinationType](../components/observabilityrampdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilityrampdestinationconfig.mdx b/docs/components/observabilityrampdestinationconfig.mdx index a60daa343..809d417c9 100644 --- a/docs/components/observabilityrampdestinationconfig.mdx +++ b/docs/components/observabilityrampdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityRampDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `api_key` | *str* | ✅ | Generate this in your Ramp integration settings. | -| `base_url` | *Optional[str]* | ➖ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file +| `api_key` | *str* | :heavy_check_mark: | Generate this in your Ramp integration settings. | +| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file diff --git a/docs/components/observabilitys3destination.mdx b/docs/components/observabilitys3destination.mdx index 4e44982ae..2de0187cd 100644 --- a/docs/components/observabilitys3destination.mdx +++ b/docs/components/observabilitys3destination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityS3Destination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityS3DestinationConfig](../components/observabilitys3destinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityS3DestinationType](../components/observabilitys3destinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityS3DestinationConfig](../components/observabilitys3destinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityS3DestinationType](../components/observabilitys3destinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitys3destinationconfig.mdx b/docs/components/observabilitys3destinationconfig.mdx index e6dfccca9..397420955 100644 --- a/docs/components/observabilitys3destinationconfig.mdx +++ b/docs/components/observabilitys3destinationconfig.mdx @@ -6,12 +6,12 @@ title: "ObservabilityS3DestinationConfig" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `access_key_id` | *str* | ✅ | N/A | -| `bucket_name` | *str* | ✅ | N/A | -| `endpoint` | *Optional[str]* | ➖ | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `path_template` | *Optional[str]* | ➖ | Template for S3 object path. The filename (\{traceId}-\{timestamp}.json) is automatically appended. Available variables: \{prefix}, \{date}, \{year}, \{month}, \{day}, \{apiKeyName} | -| `prefix` | *Optional[str]* | ➖ | N/A | -| `region` | *Optional[str]* | ➖ | N/A | -| `secret_access_key` | *str* | ✅ | N/A | -| `session_token` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `access_key_id` | *str* | :heavy_check_mark: | N/A | +| `bucket_name` | *str* | :heavy_check_mark: | N/A | +| `endpoint` | *Optional[str]* | :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` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `path_template` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `region` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `secret_access_key` | *str* | :heavy_check_mark: | N/A | +| `session_token` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/observabilitysentrydestination.mdx b/docs/components/observabilitysentrydestination.mdx index bfd6c8e6c..d61e0cbf1 100644 --- a/docs/components/observabilitysentrydestination.mdx +++ b/docs/components/observabilitysentrydestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilitySentryDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilitySentryDestinationConfig](../components/observabilitysentrydestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilitySentryDestinationType](../components/observabilitysentrydestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilitySentryDestinationConfig](../components/observabilitysentrydestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilitySentryDestinationType](../components/observabilitysentrydestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitysentrydestinationconfig.mdx b/docs/components/observabilitysentrydestinationconfig.mdx index c2b828f39..99f775de0 100644 --- a/docs/components/observabilitysentrydestinationconfig.mdx +++ b/docs/components/observabilitysentrydestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilitySentryDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `dsn` | *str* | ✅ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `otlp_endpoint` | *str* | ✅ | N/A | \ No newline at end of file +| `dsn` | *str* | :heavy_check_mark: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `otlp_endpoint` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilitysnowflakedestination.mdx b/docs/components/observabilitysnowflakedestination.mdx index 6be7bcda4..6625d5f95 100644 --- a/docs/components/observabilitysnowflakedestination.mdx +++ b/docs/components/observabilitysnowflakedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilitySnowflakeDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilitySnowflakeDestinationConfig](../components/observabilitysnowflakedestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilitySnowflakeDestinationType](../components/observabilitysnowflakedestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilitySnowflakeDestinationConfig](../components/observabilitysnowflakedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilitySnowflakeDestinationType](../components/observabilitysnowflakedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitysnowflakedestinationconfig.mdx b/docs/components/observabilitysnowflakedestinationconfig.mdx index 60125bca6..a7b7e4788 100644 --- a/docs/components/observabilitysnowflakedestinationconfig.mdx +++ b/docs/components/observabilitysnowflakedestinationconfig.mdx @@ -6,11 +6,11 @@ title: "ObservabilitySnowflakeDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `account` | *str* | ✅ | N/A | -| `database` | *Optional[str]* | ➖ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `schema_` | *Optional[str]* | ➖ | N/A | -| `should_include_cache_write_tokens` | *Optional[bool]* | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `table` | *Optional[str]* | ➖ | N/A | -| `token` | *str* | ✅ | N/A | -| `warehouse` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `account` | *str* | :heavy_check_mark: | N/A | +| `database` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `should_include_cache_write_tokens` | *Optional[bool]* | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `table` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | +| `warehouse` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/observabilityweavedestination.mdx b/docs/components/observabilityweavedestination.mdx index 7579a2c79..b60a11276 100644 --- a/docs/components/observabilityweavedestination.mdx +++ b/docs/components/observabilityweavedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityWeaveDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityWeaveDestinationConfig](../components/observabilityweavedestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityWeaveDestinationType](../components/observabilityweavedestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityWeaveDestinationConfig](../components/observabilityweavedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityWeaveDestinationType](../components/observabilityweavedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilityweavedestinationconfig.mdx b/docs/components/observabilityweavedestinationconfig.mdx index 9a47f314c..890078548 100644 --- a/docs/components/observabilityweavedestinationconfig.mdx +++ b/docs/components/observabilityweavedestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityWeaveDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | ✅ | N/A | -| `base_url` | *Optional[str]* | ➖ | N/A | -| `entity` | *str* | ✅ | N/A | -| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | -| `project` | *str* | ✅ | N/A | \ No newline at end of file +| `api_key` | *str* | :heavy_check_mark: | N/A | +| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `entity` | *str* | :heavy_check_mark: | N/A | +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `project` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/observabilitywebhookdestination.mdx b/docs/components/observabilitywebhookdestination.mdx index 2c7e94483..9476e2dbd 100644 --- a/docs/components/observabilitywebhookdestination.mdx +++ b/docs/components/observabilitywebhookdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityWebhookDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityWebhookDestinationConfig](../components/observabilitywebhookdestinationconfig.mdx) | ✅ | N/A | | -| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityWebhookDestinationType](../components/observabilitywebhookdestinationtype.mdx) | ✅ | N/A | | -| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityWebhookDestinationConfig](../components/observabilitywebhookdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `created_at` | *str* | :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 | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../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"
] | +| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityWebhookDestinationType](../components/observabilitywebhookdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/observabilitywebhookdestinationconfig.mdx b/docs/components/observabilitywebhookdestinationconfig.mdx index b05354574..8dab0b1a2 100644 --- a/docs/components/observabilitywebhookdestinationconfig.mdx +++ b/docs/components/observabilitywebhookdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityWebhookDestinationConfig" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `headers` | Dict[str, *str*] | ➖ | N/A | -| `method` | [Optional[components.Method]](../components/method.mdx) | ➖ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `headers` | Dict[str, *str*] | :heavy_minus_sign: | N/A | +| `method` | [Optional[components.Method]](../components/method.mdx) | :heavy_minus_sign: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openaifile.mdx b/docs/components/openaifile.mdx index 6f7c92c6f..83aa79140 100644 --- a/docs/components/openaifile.mdx +++ b/docs/components/openaifile.mdx @@ -9,11 +9,11 @@ A stored file in OpenAI's Files API shape. | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `shape` | [components.OpenAIFileShape](../components/openaifileshape.mdx) | ✅ | N/A | -| `bytes_` | *int* | ✅ | N/A | -| `created_at` | *int* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `object` | [components.OpenAIFileObject](../components/openaifileobject.mdx) | ✅ | N/A | -| `purpose` | [components.Purpose](../components/purpose.mdx) | ✅ | N/A | -| `status` | [components.OpenAIFileStatus](../components/openaifilestatus.mdx) | ✅ | N/A | \ No newline at end of file +| `shape` | [components.OpenAIFileShape](../components/openaifileshape.mdx) | :heavy_check_mark: | N/A | +| `bytes_` | *int* | :heavy_check_mark: | N/A | +| `created_at` | *int* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `object` | [components.OpenAIFileObject](../components/openaifileobject.mdx) | :heavy_check_mark: | N/A | +| `purpose` | [components.Purpose](../components/purpose.mdx) | :heavy_check_mark: | N/A | +| `status` | [components.OpenAIFileStatus](../components/openaifilestatus.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openaifiledeleted.mdx b/docs/components/openaifiledeleted.mdx index d8fcb6ae6..24db73f81 100644 --- a/docs/components/openaifiledeleted.mdx +++ b/docs/components/openaifiledeleted.mdx @@ -9,7 +9,7 @@ Deletion result in OpenAI's shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `shape` | [components.OpenAIFileDeletedShape](../components/openaifiledeletedshape.mdx) | ✅ | N/A | -| `deleted` | *Literal[True]* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `object` | [components.OpenAIFileDeletedObject](../components/openaifiledeletedobject.mdx) | ✅ | N/A | \ No newline at end of file +| `shape` | [components.OpenAIFileDeletedShape](../components/openaifiledeletedshape.mdx) | :heavy_check_mark: | N/A | +| `deleted` | *Literal[True]* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `object` | [components.OpenAIFileDeletedObject](../components/openaifiledeletedobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openaifilelist.mdx b/docs/components/openaifilelist.mdx index b31e5333c..d365da303 100644 --- a/docs/components/openaifilelist.mdx +++ b/docs/components/openaifilelist.mdx @@ -9,9 +9,9 @@ A page of files in OpenAI's shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `shape` | [components.OpenAIFileListShape](../components/openaifilelistshape.mdx) | ✅ | N/A | -| `data` | List[[components.OpenAIFile](../components/openaifile.mdx)] | ✅ | N/A | -| `first_id` | *Nullable[str]* | ✅ | N/A | -| `has_more` | *bool* | ✅ | N/A | -| `last_id` | *Nullable[str]* | ✅ | N/A | -| `object` | [components.OpenAIFileListObject](../components/openaifilelistobject.mdx) | ✅ | N/A | \ No newline at end of file +| `shape` | [components.OpenAIFileListShape](../components/openaifilelistshape.mdx) | :heavy_check_mark: | N/A | +| `data` | List[[components.OpenAIFile](../components/openaifile.mdx)] | :heavy_check_mark: | N/A | +| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `has_more` | *bool* | :heavy_check_mark: | N/A | +| `last_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `object` | [components.OpenAIFileListObject](../components/openaifilelistobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsecustomtoolcall.mdx b/docs/components/openairesponsecustomtoolcall.mdx index 77290a83c..fdcac04a3 100644 --- a/docs/components/openairesponsecustomtoolcall.mdx +++ b/docs/components/openairesponsecustomtoolcall.mdx @@ -6,10 +6,10 @@ title: "OpenAIResponseCustomToolCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `async_` | *Optional[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 | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `input` | *str* | ✅ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `type` | [components.OpenAIResponseCustomToolCallType](../components/openairesponsecustomtoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `async_` | *Optional[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 | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `input` | *str* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `type` | [components.OpenAIResponseCustomToolCallType](../components/openairesponsecustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/openairesponsecustomtoolcalloutput.mdx b/docs/components/openairesponsecustomtoolcalloutput.mdx index e3440b286..a5539655b 100644 --- a/docs/components/openairesponsecustomtoolcalloutput.mdx +++ b/docs/components/openairesponsecustomtoolcalloutput.mdx @@ -6,7 +6,7 @@ title: "OpenAIResponseCustomToolCallOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `call_id` | *str* | ✅ | N/A | -| `id` | *Optional[str]* | ➖ | N/A | -| `output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../components/openairesponsecustomtoolcalloutputoutput2.mdx) | ✅ | N/A | -| `type` | [components.OpenAIResponseCustomToolCallOutputType](../components/openairesponsecustomtoolcalloutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../components/openairesponsecustomtoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.OpenAIResponseCustomToolCallOutputType](../components/openairesponsecustomtoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsefunctiontoolcall.mdx b/docs/components/openairesponsefunctiontoolcall.mdx index e53b990fd..4624a3966 100644 --- a/docs/components/openairesponsefunctiontoolcall.mdx +++ b/docs/components/openairesponsefunctiontoolcall.mdx @@ -6,13 +6,13 @@ title: "OpenAIResponseFunctionToolCall" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | ✅ | N/A | | -| `async_` | *Optional[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 | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | -| `subagent_id` | *Optional[str]* | ➖ | 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. | | -| `subagent_items` | List[[components.OpenAIResponseFunctionToolCallSubagentItem](../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](../components/openairesponsefunctiontoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | | +| `async_` | *Optional[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 | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | +| `subagent_id` | *Optional[str]* | :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. | | +| `subagent_items` | List[[components.OpenAIResponseFunctionToolCallSubagentItem](../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](../components/openairesponsefunctiontoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/openairesponsefunctiontoolcalloutput.mdx b/docs/components/openairesponsefunctiontoolcalloutput.mdx index bab1a9547..7999eeee6 100644 --- a/docs/components/openairesponsefunctiontoolcalloutput.mdx +++ b/docs/components/openairesponsefunctiontoolcalloutput.mdx @@ -6,8 +6,8 @@ title: "OpenAIResponseFunctionToolCallOutput" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../components/openairesponsefunctiontoolcalloutputoutput2.mdx) | ✅ | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | -| `type` | [components.OpenAIResponseFunctionToolCallOutputType](../components/openairesponsefunctiontoolcalloutputtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../components/openairesponsefunctiontoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | +| `type` | [components.OpenAIResponseFunctionToolCallOutputType](../components/openairesponsefunctiontoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/openairesponsefunctiontoolcallsubagentitem.mdx b/docs/components/openairesponsefunctiontoolcallsubagentitem.mdx index bdfd1e48d..b52ff9cb9 100644 --- a/docs/components/openairesponsefunctiontoolcallsubagentitem.mdx +++ b/docs/components/openairesponsefunctiontoolcallsubagentitem.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponseFunctionToolCallSubagentItem" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `type` | *str* | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/openairesponseinputmessageitem.mdx b/docs/components/openairesponseinputmessageitem.mdx index 1f5c248d0..8670ec0c1 100644 --- a/docs/components/openairesponseinputmessageitem.mdx +++ b/docs/components/openairesponseinputmessageitem.mdx @@ -6,7 +6,7 @@ title: "OpenAIResponseInputMessageItem" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.OpenAIResponseInputMessageItemContent](../components/openairesponseinputmessageitemcontent.mdx)] | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `role` | [components.OpenAIResponseInputMessageItemRoleUnion](../components/openairesponseinputmessageitemroleunion.mdx) | ✅ | N/A | -| `type` | [Optional[components.OpenAIResponseInputMessageItemType]](../components/openairesponseinputmessageitemtype.mdx) | ➖ | N/A | \ No newline at end of file +| `content` | List[[components.OpenAIResponseInputMessageItemContent](../components/openairesponseinputmessageitemcontent.mdx)] | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `role` | [components.OpenAIResponseInputMessageItemRoleUnion](../components/openairesponseinputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | +| `type` | [Optional[components.OpenAIResponseInputMessageItemType]](../components/openairesponseinputmessageitemtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsesrefusalcontent.mdx b/docs/components/openairesponsesrefusalcontent.mdx index de50c56bc..c687dab46 100644 --- a/docs/components/openairesponsesrefusalcontent.mdx +++ b/docs/components/openairesponsesrefusalcontent.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponsesRefusalContent" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `refusal` | *str* | ✅ | N/A | -| `type` | [components.OpenAIResponsesRefusalContentType](../components/openairesponsesrefusalcontenttype.mdx) | ✅ | N/A | \ No newline at end of file +| `refusal` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.OpenAIResponsesRefusalContentType](../components/openairesponsesrefusalcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsestoolchoice.mdx b/docs/components/openairesponsestoolchoice.mdx index bf509f6e0..71090a1f7 100644 --- a/docs/components/openairesponsestoolchoice.mdx +++ b/docs/components/openairesponsestoolchoice.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoice" | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | [components.Type](../components/type.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.Type](../components/type.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsestoolchoiceapplypatch.mdx b/docs/components/openairesponsestoolchoiceapplypatch.mdx index c195661a9..de012d5c1 100644 --- a/docs/components/openairesponsestoolchoiceapplypatch.mdx +++ b/docs/components/openairesponsestoolchoiceapplypatch.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceApplyPatch" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../components/openairesponsestoolchoicetypeapplypatch.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../components/openairesponsestoolchoicetypeapplypatch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsestoolchoicefunction.mdx b/docs/components/openairesponsestoolchoicefunction.mdx index 622d91c05..e08dad52c 100644 --- a/docs/components/openairesponsestoolchoicefunction.mdx +++ b/docs/components/openairesponsestoolchoicefunction.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponsesToolChoiceFunction" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `name` | *str* | ✅ | N/A | -| `type` | [components.OpenAIResponsesToolChoiceTypeFunction](../components/openairesponsestoolchoicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file +| `name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.OpenAIResponsesToolChoiceTypeFunction](../components/openairesponsestoolchoicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsestoolchoiceshell.mdx b/docs/components/openairesponsestoolchoiceshell.mdx index a8af8c0ab..b0451b76a 100644 --- a/docs/components/openairesponsestoolchoiceshell.mdx +++ b/docs/components/openairesponsestoolchoiceshell.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceShell" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesToolChoiceTypeShell](../components/openairesponsestoolchoicetypeshell.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.OpenAIResponsesToolChoiceTypeShell](../components/openairesponsestoolchoicetypeshell.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openresponsescreatedevent.mdx b/docs/components/openresponsescreatedevent.mdx index 75a6a54d5..f1b2f4719 100644 --- a/docs/components/openresponsescreatedevent.mdx +++ b/docs/components/openresponsescreatedevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is created | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | ✅ | N/A | | -| `type` | [components.OpenResponsesCreatedEventType](../components/openresponsescreatedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.OpenResponsesCreatedEventType](../components/openresponsescreatedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/openresponseserrorfield.mdx b/docs/components/openresponseserrorfield.mdx index b1640dbc5..08c26185f 100644 --- a/docs/components/openresponseserrorfield.mdx +++ b/docs/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](../components/codeenum.mdx) | ✅ | N/A | | -| `message` | *str* | ✅ | N/A | | -| `metadata` | [Optional[components.OpenResponsesErrorMetadata]](../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](../components/codeenum.mdx) | :heavy_check_mark: | N/A | | +| `message` | *str* | :heavy_check_mark: | N/A | | +| `metadata` | [Optional[components.OpenResponsesErrorMetadata]](../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/components/openresponseserrormetadata.mdx b/docs/components/openresponseserrormetadata.mdx index 770616c24..66dc83a39 100644 --- a/docs/components/openresponseserrormetadata.mdx +++ b/docs/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` | [Optional[components.OpenResponsesErrorMetadataAlignment]](../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` | [Optional[components.OpenResponsesErrorMetadataAlignment]](../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/components/openresponseserrormetadataalignment.mdx b/docs/components/openresponseserrormetadataalignment.mdx index 069d86984..2f63ffbaf 100644 --- a/docs/components/openresponseserrormetadataalignment.mdx +++ b/docs/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` | List[[components.AlignmentCallRecord](../components/alignmentcallrecord.mdx)] | ✅ | One record per evaluated assistant message of the request, in the order the messages were produced. | -| `rejected` | [Optional[components.AlignmentRejected]](../components/alignmentrejected.mdx) | ➖ | N/A | \ No newline at end of file +| `calls` | List[[components.AlignmentCallRecord](../components/alignmentcallrecord.mdx)] | :heavy_check_mark: | One record per evaluated assistant message of the request, in the order the messages were produced. | +| `rejected` | [Optional[components.AlignmentRejected]](../components/alignmentrejected.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/openresponsesinprogressevent.mdx b/docs/components/openresponsesinprogressevent.mdx index a8ce87cc2..b9c8edc51 100644 --- a/docs/components/openresponsesinprogressevent.mdx +++ b/docs/components/openresponsesinprogressevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is in progress | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | ✅ | N/A | | -| `type` | [components.OpenResponsesInProgressEventType](../components/openresponsesinprogresseventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.OpenResponsesInProgressEventType](../components/openresponsesinprogresseventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/openresponsesresult.mdx b/docs/components/openresponsesresult.mdx index aae638dc4..31242e845 100644 --- a/docs/components/openresponsesresult.mdx +++ b/docs/components/openresponsesresult.mdx @@ -9,41 +9,41 @@ Complete non-streaming response from the Responses API | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *OptionalNullable[bool]* | ➖ | N/A | | -| `completed_at` | *Nullable[int]* | ✅ | N/A | | -| `created_at` | *int* | ✅ | N/A | | -| `error` | [Nullable[components.OpenResponsesErrorField]](../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"
}
]
}
}
} | -| `frequency_penalty` | *Nullable[float]* | ✅ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `incomplete_details` | [Nullable[components.IncompleteDetails]](../components/incompletedetails.mdx) | ✅ | N/A | \{
"reason": "max_output_tokens"
} | -| `instructions` | [Nullable[components.BaseInputsUnion]](../components/baseinputsunion.mdx) | ✅ | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | -| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | ➖ | N/A | | -| `metadata` | Dict[str, *str*] | ✅ | 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` | *str* | ✅ | N/A | | -| `object` | [components.OpenResponsesResultObject](../components/openresponsesresultobject.mdx) | ✅ | N/A | | -| `output` | List[[components.OutputItems](../components/outputitems.mdx)] | ✅ | N/A | | -| `output_text` | *Optional[str]* | ➖ | N/A | | -| `parallel_tool_calls` | *bool* | ✅ | N/A | | -| `presence_penalty` | *Nullable[float]* | ✅ | N/A | | -| `previous_response_id` | *OptionalNullable[str]* | ➖ | N/A | | -| `prompt` | [OptionalNullable[components.StoredPromptTemplate]](../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.BaseReasoningConfig]](../components/basereasoningconfig.mdx) | ➖ | N/A | \{
"effort": "medium",
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | ➖ | N/A | | -| `service_tier` | *OptionalNullable[str]* | ➖ | N/A | | -| `status` | [components.OpenAIResponsesResponseStatus](../components/openairesponsesresponsestatus.mdx) | ✅ | N/A | completed | -| `store` | *Optional[bool]* | ➖ | N/A | | -| `temperature` | *Nullable[float]* | ✅ | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [components.OpenAIResponsesToolChoiceUnion](../components/openairesponsestoolchoiceunion.mdx) | ✅ | N/A | auto | -| `tools` | List[[components.OpenResponsesResultToolUnion](../components/openresponsesresulttoolunion.mdx)] | ✅ | N/A | | -| `top_logprobs` | *Optional[int]* | ➖ | N/A | | -| `top_p` | *Nullable[float]* | ✅ | N/A | | -| `truncation` | [OptionalNullable[components.Truncation]](../components/truncation.mdx) | ➖ | N/A | auto | -| `usage` | [OptionalNullable[components.Usage]](../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[str]* | ➖ | N/A | | -| `alignment` | [Optional[components.Alignment]](../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
}
]
}
]
} | -| `error_type` | [Optional[components.APIErrorType]](../components/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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[bool]* | :heavy_minus_sign: | N/A | | +| `completed_at` | *Nullable[int]* | :heavy_check_mark: | N/A | | +| `created_at` | *int* | :heavy_check_mark: | N/A | | +| `error` | [Nullable[components.OpenResponsesErrorField]](../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"
}
]
}
}
} | +| `frequency_penalty` | *Nullable[float]* | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `incomplete_details` | [Nullable[components.IncompleteDetails]](../components/incompletedetails.mdx) | :heavy_check_mark: | N/A | \{
"reason": "max_output_tokens"
} | +| `instructions` | [Nullable[components.BaseInputsUnion]](../components/baseinputsunion.mdx) | :heavy_check_mark: | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `metadata` | Dict[str, *str*] | :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` | *str* | :heavy_check_mark: | N/A | | +| `object` | [components.OpenResponsesResultObject](../components/openresponsesresultobject.mdx) | :heavy_check_mark: | N/A | | +| `output` | List[[components.OutputItems](../components/outputitems.mdx)] | :heavy_check_mark: | N/A | | +| `output_text` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `parallel_tool_calls` | *bool* | :heavy_check_mark: | N/A | | +| `presence_penalty` | *Nullable[float]* | :heavy_check_mark: | N/A | | +| `previous_response_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `prompt` | [OptionalNullable[components.StoredPromptTemplate]](../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.BaseReasoningConfig]](../components/basereasoningconfig.mdx) | :heavy_minus_sign: | N/A | \{
"effort": "medium",
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.OpenAIResponsesResponseStatus](../components/openairesponsesresponsestatus.mdx) | :heavy_check_mark: | N/A | completed | +| `store` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `temperature` | *Nullable[float]* | :heavy_check_mark: | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [components.OpenAIResponsesToolChoiceUnion](../components/openairesponsestoolchoiceunion.mdx) | :heavy_check_mark: | N/A | auto | +| `tools` | List[[components.OpenResponsesResultToolUnion](../components/openresponsesresulttoolunion.mdx)] | :heavy_check_mark: | N/A | | +| `top_logprobs` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `top_p` | *Nullable[float]* | :heavy_check_mark: | N/A | | +| `truncation` | [OptionalNullable[components.Truncation]](../components/truncation.mdx) | :heavy_minus_sign: | N/A | auto | +| `usage` | [OptionalNullable[components.Usage]](../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[str]* | :heavy_minus_sign: | N/A | | +| `alignment` | [Optional[components.Alignment]](../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
}
]
}
]
} | +| `error_type` | [Optional[components.APIErrorType]](../components/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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/components/openresponsesresulttoolfunction.mdx b/docs/components/openresponsesresulttoolfunction.mdx index c2334a7c2..69aaa0c46 100644 --- a/docs/components/openresponsesresulttoolfunction.mdx +++ b/docs/components/openresponsesresulttoolfunction.mdx @@ -9,12 +9,12 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `parameters` | Dict[str, *Any*] | ✅ | N/A | | -| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | -| `type` | [components.OpenResponsesResultType](../components/openresponsesresulttype.mdx) | ✅ | N/A | | -| `allowed_callers` | List[[components.OpenResponsesResultAllowedCaller](../components/openresponsesresultallowedcaller.mdx)] | ➖ | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | -| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | \ No newline at end of file +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `parameters` | Dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `type` | [components.OpenResponsesResultType](../components/openresponsesresulttype.mdx) | :heavy_check_mark: | N/A | | +| `allowed_callers` | List[[components.OpenResponsesResultAllowedCaller](../components/openresponsesresultallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | +| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/openrouterfile.mdx b/docs/components/openrouterfile.mdx index 2e7cf2d42..f7335e372 100644 --- a/docs/components/openrouterfile.mdx +++ b/docs/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](../components/openrouterfileshape.mdx) | ✅ | N/A | -| `created_at` | *str* | ✅ | N/A | -| `downloadable` | *bool* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `mime_type` | *str* | ✅ | N/A | -| `size_bytes` | *int* | ✅ | N/A | -| `type` | [components.OpenRouterFileType](../components/openrouterfiletype.mdx) | ✅ | N/A | \ No newline at end of file +| `shape` | [components.OpenRouterFileShape](../components/openrouterfileshape.mdx) | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `downloadable` | *bool* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `mime_type` | *str* | :heavy_check_mark: | N/A | +| `size_bytes` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.OpenRouterFileType](../components/openrouterfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openrouterfiledeleted.mdx b/docs/components/openrouterfiledeleted.mdx index 76e59c88d..af6a578a5 100644 --- a/docs/components/openrouterfiledeleted.mdx +++ b/docs/components/openrouterfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in the OpenRouter shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `shape` | [components.OpenRouterFileDeletedShape](../components/openrouterfiledeletedshape.mdx) | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `type` | [components.OpenRouterFileDeletedType](../components/openrouterfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file +| `shape` | [components.OpenRouterFileDeletedShape](../components/openrouterfiledeletedshape.mdx) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.OpenRouterFileDeletedType](../components/openrouterfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openrouterfilelist.mdx b/docs/components/openrouterfilelist.mdx index 4dbafe0c4..16ebdba6b 100644 --- a/docs/components/openrouterfilelist.mdx +++ b/docs/components/openrouterfilelist.mdx @@ -9,9 +9,9 @@ A page of files in the OpenRouter shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `shape` | [components.OpenRouterFileListShape](../components/openrouterfilelistshape.mdx) | ✅ | N/A | -| `cursor` | *Nullable[str]* | ✅ | Opaque cursor for the next page; null when there are no more results. | -| `data` | List[[components.OpenRouterFile](../components/openrouterfile.mdx)] | ✅ | N/A | -| `first_id` | *Nullable[str]* | ✅ | N/A | -| `has_more` | *bool* | ✅ | N/A | -| `last_id` | *Nullable[str]* | ✅ | N/A | \ No newline at end of file +| `shape` | [components.OpenRouterFileListShape](../components/openrouterfilelistshape.mdx) | :heavy_check_mark: | N/A | +| `cursor` | *Nullable[str]* | :heavy_check_mark: | Opaque cursor for the next page; null when there are no more results. | +| `data` | List[[components.OpenRouterFile](../components/openrouterfile.mdx)] | :heavy_check_mark: | N/A | +| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `has_more` | *bool* | :heavy_check_mark: | N/A | +| `last_id` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/openroutermetadata.mdx b/docs/components/openroutermetadata.mdx index c0c25946e..4cbe15712 100644 --- a/docs/components/openroutermetadata.mdx +++ b/docs/components/openroutermetadata.mdx @@ -6,14 +6,14 @@ title: "OpenRouterMetadata" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `attempt` | *int* | ✅ | N/A | | -| `attempts` | List[[components.RouterAttempt](../components/routerattempt.mdx)] | ➖ | N/A | | -| `endpoints` | [components.EndpointsMetadata](../components/endpointsmetadata.mdx) | ✅ | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | -| `generation_time` | *Optional[int]* | ➖ | 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 | -| `is_byok` | *bool* | ✅ | N/A | | -| `params` | [Optional[components.RouterParams]](../components/routerparams.mdx) | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | -| `pipeline` | List[[components.PipelineStage](../components/pipelinestage.mdx)] | ➖ | N/A | | -| `region` | *Nullable[str]* | ✅ | N/A | | -| `requested` | *str* | ✅ | N/A | | -| `strategy` | [components.RoutingStrategy](../components/routingstrategy.mdx) | ✅ | N/A | direct | -| `summary` | *str* | ✅ | N/A | | \ No newline at end of file +| `attempt` | *int* | :heavy_check_mark: | N/A | | +| `attempts` | List[[components.RouterAttempt](../components/routerattempt.mdx)] | :heavy_minus_sign: | N/A | | +| `endpoints` | [components.EndpointsMetadata](../components/endpointsmetadata.mdx) | :heavy_check_mark: | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | +| `generation_time` | *Optional[int]* | :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 | +| `is_byok` | *bool* | :heavy_check_mark: | N/A | | +| `params` | [Optional[components.RouterParams]](../components/routerparams.mdx) | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | +| `pipeline` | List[[components.PipelineStage](../components/pipelinestage.mdx)] | :heavy_minus_sign: | N/A | | +| `region` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `requested` | *str* | :heavy_check_mark: | N/A | | +| `strategy` | [components.RoutingStrategy](../components/routingstrategy.mdx) | :heavy_check_mark: | N/A | direct | +| `summary` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/openrouterwebsearchservertool.mdx b/docs/components/openrouterwebsearchservertool.mdx index 929334d2f..3842a52e2 100644 --- a/docs/components/openrouterwebsearchservertool.mdx +++ b/docs/components/openrouterwebsearchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.WebSearchConfig]](../components/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `type` | [components.OpenRouterWebSearchServerToolType](../components/openrouterwebsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.WebSearchConfig]](../components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `type` | [components.OpenRouterWebSearchServerToolType](../components/openrouterwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/oranthropicbashtoolresult.mdx b/docs/components/oranthropicbashtoolresult.mdx index 42292ca7c..4428fcec1 100644 --- a/docs/components/oranthropicbashtoolresult.mdx +++ b/docs/components/oranthropicbashtoolresult.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:bash` call executed in the OpenRouter sandbox (`engine: | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *Optional[str]* | ➖ | 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` | Dict[str, *Any*] | ✅ | N/A | -| `files` | List[[components.ORAnthropicBashToolResultFile](../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. | -| `tool_use_id` | *str* | ✅ | N/A | -| `type` | [components.ORAnthropicBashToolResultTypeOpenrouterBashToolResult](../components/oranthropicbashtoolresulttypeopenrouterbashtoolresult.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *Optional[str]* | :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` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `files` | List[[components.ORAnthropicBashToolResultFile](../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. | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ORAnthropicBashToolResultTypeOpenrouterBashToolResult](../components/oranthropicbashtoolresulttypeopenrouterbashtoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/oranthropicbashtoolresultfile.mdx b/docs/components/oranthropicbashtoolresultfile.mdx index 78c476877..350d2e761 100644 --- a/docs/components/oranthropicbashtoolresultfile.mdx +++ b/docs/components/oranthropicbashtoolresultfile.mdx @@ -6,9 +6,9 @@ title: "ORAnthropicBashToolResultFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | ✅ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `file_id` | *str* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `type` | [components.ORAnthropicBashToolResultTypeContainerFileCitation](../components/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *str* | :heavy_check_mark: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ORAnthropicBashToolResultTypeContainerFileCitation](../components/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/oranthropicservertooluseblock.mdx b/docs/components/oranthropicservertooluseblock.mdx index 8cdfffcc2..f88678aca 100644 --- a/docs/components/oranthropicservertooluseblock.mdx +++ b/docs/components/oranthropicservertooluseblock.mdx @@ -6,8 +6,8 @@ title: "ORAnthropicServerToolUseBlock" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `caller` | [OptionalNullable[components.ORAnthropicNullableCaller]](../components/oranthropicnullablecaller.mdx) | ➖ | N/A | \{
"type": "direct"
} | -| `id` | *str* | ✅ | N/A | | -| `input` | *Optional[Any]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `type` | [components.ORAnthropicServerToolUseBlockType](../components/oranthropicservertooluseblocktype.mdx) | ✅ | N/A | | \ No newline at end of file +| `caller` | [OptionalNullable[components.ORAnthropicNullableCaller]](../components/oranthropicnullablecaller.mdx) | :heavy_minus_sign: | N/A | \{
"type": "direct"
} | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `input` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.ORAnthropicServerToolUseBlockType](../components/oranthropicservertooluseblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/oranthropicshelltoolresult.mdx b/docs/components/oranthropicshelltoolresult.mdx index b9d19c835..4ac936c44 100644 --- a/docs/components/oranthropicshelltoolresult.mdx +++ b/docs/components/oranthropicshelltoolresult.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:shell` call executed in the OpenRouter sandbox | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *Optional[str]* | ➖ | 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` | Dict[str, *Any*] | ✅ | N/A | -| `files` | List[[components.ORAnthropicShellToolResultFile](../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. | -| `tool_use_id` | *str* | ✅ | N/A | -| `type` | [components.ORAnthropicShellToolResultTypeOpenrouterShellToolResult](../components/oranthropicshelltoolresulttypeopenroutershelltoolresult.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *Optional[str]* | :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` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `files` | List[[components.ORAnthropicShellToolResultFile](../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. | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ORAnthropicShellToolResultTypeOpenrouterShellToolResult](../components/oranthropicshelltoolresulttypeopenroutershelltoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/oranthropicshelltoolresultfile.mdx b/docs/components/oranthropicshelltoolresultfile.mdx index 5784ab73e..8ffa1419e 100644 --- a/docs/components/oranthropicshelltoolresultfile.mdx +++ b/docs/components/oranthropicshelltoolresultfile.mdx @@ -6,9 +6,9 @@ title: "ORAnthropicShellToolResultFile" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | ✅ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `file_id` | *str* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `type` | [components.ORAnthropicShellToolResultTypeContainerFileCitation](../components/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *str* | :heavy_check_mark: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ORAnthropicShellToolResultTypeContainerFileCitation](../components/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/oranthropictoolsearchresult.mdx b/docs/components/oranthropictoolsearchresult.mdx index 8b134c415..ba9b09a97 100644 --- a/docs/components/oranthropictoolsearchresult.mdx +++ b/docs/components/oranthropictoolsearchresult.mdx @@ -9,6 +9,6 @@ Router-owned deferred discovery result containing original selected tool definit | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `content` | Dict[str, *Any*] | ✅ | N/A | -| `tool_use_id` | *str* | ✅ | N/A | -| `type` | [components.ORAnthropicToolSearchResultType](../components/oranthropictoolsearchresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ORAnthropicToolSearchResultType](../components/oranthropictoolsearchresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/oranthropictoolsearchresultparam.mdx b/docs/components/oranthropictoolsearchresultparam.mdx index 3a01b4006..2bd24bad1 100644 --- a/docs/components/oranthropictoolsearchresultparam.mdx +++ b/docs/components/oranthropictoolsearchresultparam.mdx @@ -9,6 +9,6 @@ Router-owned deferred discovery result for continuation. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `content` | Dict[str, *Any*] | ✅ | N/A | -| `tool_use_id` | *str* | ✅ | N/A | -| `type` | [components.ORAnthropicToolSearchResultParamType](../components/oranthropictoolsearchresultparamtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `tool_use_id` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ORAnthropicToolSearchResultParamType](../components/oranthropictoolsearchresultparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/organizationsettings.mdx b/docs/components/organizationsettings.mdx index c8e3952d6..6a67a56e8 100644 --- a/docs/components/organizationsettings.mdx +++ b/docs/components/organizationsettings.mdx @@ -6,5 +6,5 @@ title: "OrganizationSettings" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | -| `is_filtered_model_catalog_enabled` | *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` | *str* | :heavy_check_mark: | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | +| `is_filtered_model_catalog_enabled` | *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/components/outcomeexit.mdx b/docs/components/outcomeexit.mdx index 98046ccf3..56aaef49a 100644 --- a/docs/components/outcomeexit.mdx +++ b/docs/components/outcomeexit.mdx @@ -6,6 +6,6 @@ title: "OutcomeExit" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `exit_code` | *int* | ✅ | N/A | -| `type` | [components.TypeExit](../components/typeexit.mdx) | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `exit_code` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.TypeExit](../components/typeexit.mdx) | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/outcometimeout.mdx b/docs/components/outcometimeout.mdx index e093c9b5a..2dc6cbbbd 100644 --- a/docs/components/outcometimeout.mdx +++ b/docs/components/outcometimeout.mdx @@ -6,5 +6,5 @@ title: "OutcomeTimeout" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `type` | [components.TypeTimeout](../components/typetimeout.mdx) | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `type` | [components.TypeTimeout](../components/typetimeout.mdx) | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/outputadvisorservertoolitem.mdx b/docs/components/outputadvisorservertoolitem.mdx index 0ee933722..856695ef8 100644 --- a/docs/components/outputadvisorservertoolitem.mdx +++ b/docs/components/outputadvisorservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:advisor server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `advice` | *Optional[str]* | ➖ | The advisor model's response (the advice text returned to the executor). | | -| `error` | *Optional[str]* | ➖ | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `instance_name` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Slug of the advisor model that was consulted. | | -| `prompt` | *Optional[str]* | ➖ | The prompt the executor sent to the advisor. | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputAdvisorServerToolItemType](../components/outputadvisorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `advice` | *Optional[str]* | :heavy_minus_sign: | The advisor model's response (the advice text returned to the executor). | | +| `error` | *Optional[str]* | :heavy_minus_sign: | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `instance_name` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Slug of the advisor model that was consulted. | | +| `prompt` | *Optional[str]* | :heavy_minus_sign: | The prompt the executor sent to the advisor. | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputAdvisorServerToolItemType](../components/outputadvisorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputapplypatchcallitem.mdx b/docs/components/outputapplypatchcallitem.mdx index 36691c60e..2a02c6e3d 100644 --- a/docs/components/outputapplypatchcallitem.mdx +++ b/docs/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 | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `operation` | [components.ApplyPatchCallOperation](../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](../components/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | [components.OutputApplyPatchCallItemType](../components/outputapplypatchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `operation` | [components.ApplyPatchCallOperation](../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](../components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | +| `type` | [components.OutputApplyPatchCallItemType](../components/outputapplypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputapplypatchservertoolitem.mdx b/docs/components/outputapplypatchservertoolitem.mdx index 2a6f09950..d8e965bb7 100644 --- a/docs/components/outputapplypatchservertoolitem.mdx +++ b/docs/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 | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *Optional[str]* | ➖ | N/A | | -| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | -| `operation` | [Optional[components.ApplyPatchCallOperation]](../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](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputApplyPatchServerToolItemType](../components/outputapplypatchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `call_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `operation` | [Optional[components.ApplyPatchCallOperation]](../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](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputApplyPatchServerToolItemType](../components/outputapplypatchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputarmorblockeditem.mdx b/docs/components/outputarmorblockeditem.mdx index a36c56713..b1d7b64cd 100644 --- a/docs/components/outputarmorblockeditem.mdx +++ b/docs/components/outputarmorblockeditem.mdx @@ -9,12 +9,12 @@ A client tool call that OpenRouter Armor blocked. Emitted in place of the call w | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | ✅ | The arguments exactly as the model wrote them. | -| `call_id` | *str* | ✅ | The call id the model chose. Use it to find this call in `safeguard_results`. | -| `explanation` | *str* | ✅ | The rule that blocked the call, in the same `[Rule Name]` form as `safeguard_results`. | -| `id` | *str* | ✅ | N/A | -| `name` | *str* | ✅ | The name of the tool the model called. | -| `namespace` | *Optional[str]* | ➖ | The namespace the tool belongs to, for namespaced tools such as MCP. Absent for a plain function tool. | -| `reason` | *str* | ✅ | The error text the model received as the result of this call. Sending this item back replays that text to the model. | -| `status` | [components.OutputArmorBlockedItemStatus](../components/outputarmorblockeditemstatus.mdx) | ✅ | N/A | -| `type` | [components.OutputArmorBlockedItemType](../components/outputarmorblockeditemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | The arguments exactly as the model wrote them. | +| `call_id` | *str* | :heavy_check_mark: | The call id the model chose. Use it to find this call in `safeguard_results`. | +| `explanation` | *str* | :heavy_check_mark: | The rule that blocked the call, in the same `[Rule Name]` form as `safeguard_results`. | +| `id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | The name of the tool the model called. | +| `namespace` | *Optional[str]* | :heavy_minus_sign: | The namespace the tool belongs to, for namespaced tools such as MCP. Absent for a plain function tool. | +| `reason` | *str* | :heavy_check_mark: | The error text the model received as the result of this call. Sending this item back replays that text to the model. | +| `status` | [components.OutputArmorBlockedItemStatus](../components/outputarmorblockeditemstatus.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.OutputArmorBlockedItemType](../components/outputarmorblockeditemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputbashservertoolitem.mdx b/docs/components/outputbashservertoolitem.mdx index e2290a047..30a101b0a 100644 --- a/docs/components/outputbashservertoolitem.mdx +++ b/docs/components/outputbashservertoolitem.mdx @@ -9,15 +9,15 @@ An openrouter:bash server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *OptionalNullable[str]* | ➖ | The raw tool-call arguments string as emitted by the model. | | -| `call_id` | *OptionalNullable[str]* | ➖ | The model-generated tool call id from the originating turn. | | -| `command` | *Optional[str]* | ➖ | N/A | | -| `container_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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. | | -| `exit_code` | *Optional[int]* | ➖ | N/A | | -| `files` | List[[components.OutputBashServerToolItemFile](../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` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `stderr` | *Optional[str]* | ➖ | N/A | | -| `stdout` | *Optional[str]* | ➖ | N/A | | -| `type` | [components.OutputBashServerToolItemTypeOpenrouterBash](../components/outputbashservertoolitemtypeopenrouterbash.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *OptionalNullable[str]* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | +| `call_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | +| `command` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `container_id` | *Optional[str]* | :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` | *Optional[str]* | :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. | | +| `exit_code` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `files` | List[[components.OutputBashServerToolItemFile](../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `stderr` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `stdout` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.OutputBashServerToolItemTypeOpenrouterBash](../components/outputbashservertoolitemtypeopenrouterbash.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputbashservertoolitemfile.mdx b/docs/components/outputbashservertoolitemfile.mdx index 14b756bdc..9e4f74c6c 100644 --- a/docs/components/outputbashservertoolitemfile.mdx +++ b/docs/components/outputbashservertoolitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputBashServerToolItemFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | ✅ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `file_id` | *str* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `type` | [components.OutputBashServerToolItemTypeContainerFileCitation](../components/outputbashservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *str* | :heavy_check_mark: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.OutputBashServerToolItemTypeContainerFileCitation](../components/outputbashservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputbrowseruseservertoolitem.mdx b/docs/components/outputbrowseruseservertoolitem.mdx index b2ced565f..d8f75dc43 100644 --- a/docs/components/outputbrowseruseservertoolitem.mdx +++ b/docs/components/outputbrowseruseservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:browser_use server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `action` | *Optional[str]* | ➖ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `screenshot_b64` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputBrowserUseServerToolItemType](../components/outputbrowseruseservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `action` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `screenshot_b64` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputBrowserUseServerToolItemType](../components/outputbrowseruseservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputcodeinterpretercallitem.mdx b/docs/components/outputcodeinterpretercallitem.mdx index 174dee5c3..2998f9693 100644 --- a/docs/components/outputcodeinterpretercallitem.mdx +++ b/docs/components/outputcodeinterpretercallitem.mdx @@ -9,10 +9,10 @@ A code interpreter execution call with outputs | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *OptionalNullable[str]* | ➖ | N/A | | -| `container_id` | *Optional[str]* | ➖ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `outputs` | List[[components.OutputCodeInterpreterCallItemOutput](../components/outputcodeinterpretercallitemoutput.mdx)] | ➖ | N/A | | -| `status` | [components.OutputCodeInterpreterCallItemStatus](../components/outputcodeinterpretercallitemstatus.mdx) | ✅ | N/A | | -| `type` | [components.OutputCodeInterpreterCallItemType](../components/outputcodeinterpretercallitemtype.mdx) | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *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[str]* | :heavy_minus_sign: | N/A | | +| `container_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `outputs` | List[[components.OutputCodeInterpreterCallItemOutput](../components/outputcodeinterpretercallitemoutput.mdx)] | :heavy_minus_sign: | N/A | | +| `status` | [components.OutputCodeInterpreterCallItemStatus](../components/outputcodeinterpretercallitemstatus.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.OutputCodeInterpreterCallItemType](../components/outputcodeinterpretercallitemtype.mdx) | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/outputcodeinterpreterservertoolitem.mdx b/docs/components/outputcodeinterpreterservertoolitem.mdx index 912fac3ed..3b97b10ff 100644 --- a/docs/components/outputcodeinterpreterservertoolitem.mdx +++ b/docs/components/outputcodeinterpreterservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:code_interpreter server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `code` | *Optional[str]* | ➖ | N/A | | -| `exit_code` | *Optional[int]* | ➖ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `language` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `stderr` | *Optional[str]* | ➖ | N/A | | -| `stdout` | *Optional[str]* | ➖ | N/A | | -| `type` | [components.OutputCodeInterpreterServerToolItemType](../components/outputcodeinterpreterservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `code` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `exit_code` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `language` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `stderr` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `stdout` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.OutputCodeInterpreterServerToolItemType](../components/outputcodeinterpreterservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputcomputercallitem.mdx b/docs/components/outputcomputercallitem.mdx index 80f347e66..f765c59f3 100644 --- a/docs/components/outputcomputercallitem.mdx +++ b/docs/components/outputcomputercallitem.mdx @@ -6,9 +6,9 @@ title: "OutputComputerCallItem" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `action` | *Optional[Any]* | ➖ | N/A | -| `call_id` | *str* | ✅ | N/A | -| `id` | *Optional[str]* | ➖ | N/A | -| `pending_safety_checks` | List[[components.PendingSafetyCheck](../components/pendingsafetycheck.mdx)] | ✅ | N/A | -| `status` | [components.OutputComputerCallItemStatus](../components/outputcomputercallitemstatus.mdx) | ✅ | N/A | -| `type` | [components.OutputComputerCallItemType](../components/outputcomputercallitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `action` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `call_id` | *str* | :heavy_check_mark: | N/A | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `pending_safety_checks` | List[[components.PendingSafetyCheck](../components/pendingsafetycheck.mdx)] | :heavy_check_mark: | N/A | +| `status` | [components.OutputComputerCallItemStatus](../components/outputcomputercallitemstatus.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.OutputComputerCallItemType](../components/outputcomputercallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputcustomtoolcallitem.mdx b/docs/components/outputcustomtoolcallitem.mdx index ab9194912..a9d4295dc 100644 --- a/docs/components/outputcustomtoolcallitem.mdx +++ b/docs/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_` | *Optional[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 | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `input` | *str* | ✅ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.OutputCustomToolCallItemStatus]](../components/outputcustomtoolcallitemstatus.mdx) | ➖ | N/A | | -| `type` | [components.OutputCustomToolCallItemType](../components/outputcustomtoolcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `async_` | *Optional[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 | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `input` | *str* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.OutputCustomToolCallItemStatus]](../components/outputcustomtoolcallitemstatus.mdx) | :heavy_minus_sign: | N/A | | +| `type` | [components.OutputCustomToolCallItemType](../components/outputcustomtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputdatetimeitem.mdx b/docs/components/outputdatetimeitem.mdx index eb8558d45..a3abcac18 100644 --- a/docs/components/outputdatetimeitem.mdx +++ b/docs/components/outputdatetimeitem.mdx @@ -9,9 +9,9 @@ An openrouter:datetime server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `datetime_` | *str* | ✅ | ISO 8601 datetime string | | -| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `timezone` | *str* | ✅ | IANA timezone name | | -| `type` | [components.OutputDatetimeItemType](../components/outputdatetimeitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `datetime_` | *str* | :heavy_check_mark: | ISO 8601 datetime string | | +| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `timezone` | *str* | :heavy_check_mark: | IANA timezone name | | +| `type` | [components.OutputDatetimeItemType](../components/outputdatetimeitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputfilesearchcallitem.mdx b/docs/components/outputfilesearchcallitem.mdx index c8463cc8a..9b9ef4445 100644 --- a/docs/components/outputfilesearchcallitem.mdx +++ b/docs/components/outputfilesearchcallitem.mdx @@ -6,7 +6,7 @@ title: "OutputFileSearchCallItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | | -| `queries` | List[*str*] | ✅ | N/A | | -| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputFileSearchCallItemType](../components/outputfilesearchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | N/A | | +| `queries` | List[*str*] | :heavy_check_mark: | N/A | | +| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputFileSearchCallItemType](../components/outputfilesearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputfilesearchservertoolitem.mdx b/docs/components/outputfilesearchservertoolitem.mdx index 38a9f0790..2095688ca 100644 --- a/docs/components/outputfilesearchservertoolitem.mdx +++ b/docs/components/outputfilesearchservertoolitem.mdx @@ -9,7 +9,7 @@ An openrouter:file_search server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | ➖ | N/A | | -| `queries` | List[*str*] | ➖ | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputFileSearchServerToolItemType](../components/outputfilesearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `queries` | List[*str*] | :heavy_minus_sign: | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputFileSearchServerToolItemType](../components/outputfilesearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputfilesservertoolitem.mdx b/docs/components/outputfilesservertoolitem.mdx index 6a52f38e3..f4514c8f3 100644 --- a/docs/components/outputfilesservertoolitem.mdx +++ b/docs/components/outputfilesservertoolitem.mdx @@ -9,13 +9,13 @@ An openrouter:files server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `arguments` | *OptionalNullable[str]* | ➖ | The raw tool-call arguments string as emitted by the model. | | -| `call_id` | *OptionalNullable[str]* | ➖ | The model-generated tool call id from the originating turn. | | -| `error` | *Optional[str]* | ➖ | Error message when the file operation failed. | | -| `file_id` | *Optional[str]* | ➖ | The target file id supplied in the tool-call arguments. | | -| `filename` | *Optional[str]* | ➖ | The target filename supplied in the tool-call arguments. | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `operation` | *Optional[str]* | ➖ | The file operation performed (list, read, write, or edit). | | -| `result` | *Optional[str]* | ➖ | JSON-serialized result of the file operation. | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputFilesServerToolItemType](../components/outputfilesservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *OptionalNullable[str]* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | +| `call_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | +| `error` | *Optional[str]* | :heavy_minus_sign: | Error message when the file operation failed. | | +| `file_id` | *Optional[str]* | :heavy_minus_sign: | The target file id supplied in the tool-call arguments. | | +| `filename` | *Optional[str]* | :heavy_minus_sign: | The target filename supplied in the tool-call arguments. | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `operation` | *Optional[str]* | :heavy_minus_sign: | The file operation performed (list, read, write, or edit). | | +| `result` | *Optional[str]* | :heavy_minus_sign: | JSON-serialized result of the file operation. | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputFilesServerToolItemType](../components/outputfilesservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputfunctioncallitem.mdx b/docs/components/outputfunctioncallitem.mdx index e3c90cdb2..d66767cb2 100644 --- a/docs/components/outputfunctioncallitem.mdx +++ b/docs/components/outputfunctioncallitem.mdx @@ -6,13 +6,13 @@ title: "OutputFunctionCallItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | ✅ | N/A | | -| `async_` | *Optional[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 | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.OutputFunctionCallItemStatusUnion]](../components/outputfunctioncallitemstatusunion.mdx) | ➖ | N/A | | -| `type` | [components.OutputFunctionCallItemType](../components/outputfunctioncallitemtype.mdx) | ✅ | N/A | | -| `subagent_id` | *Optional[str]* | ➖ | 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. | | -| `subagent_items` | List[[components.OutputFunctionCallItemSubagentItem](../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` | *str* | :heavy_check_mark: | N/A | | +| `async_` | *Optional[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 | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.OutputFunctionCallItemStatusUnion]](../components/outputfunctioncallitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | +| `type` | [components.OutputFunctionCallItemType](../components/outputfunctioncallitemtype.mdx) | :heavy_check_mark: | N/A | | +| `subagent_id` | *Optional[str]* | :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. | | +| `subagent_items` | List[[components.OutputFunctionCallItemSubagentItem](../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/components/outputfunctioncallitemsubagentitem.mdx b/docs/components/outputfunctioncallitemsubagentitem.mdx index d1a5eda8f..7cab07dcf 100644 --- a/docs/components/outputfunctioncallitemsubagentitem.mdx +++ b/docs/components/outputfunctioncallitemsubagentitem.mdx @@ -6,5 +6,5 @@ title: "OutputFunctionCallItemSubagentItem" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `type` | *str* | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/outputfusionservertoolitem.mdx b/docs/components/outputfusionservertoolitem.mdx index 1d531f3d8..90a048bd9 100644 --- a/docs/components/outputfusionservertoolitem.mdx +++ b/docs/components/outputfusionservertoolitem.mdx @@ -9,12 +9,12 @@ An openrouter:fusion server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis` | [Optional[components.FusionAnalysisResult]](../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` | *Optional[str]* | ➖ | Error message when the fusion run did not produce an analysis result. | | -| `failed_models` | List[[components.FailedModel](../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. | | -| `failure_reason` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | -| `responses` | List[[components.OutputFusionServerToolItemResponse](../components/outputfusionservertoolitemresponse.mdx)] | ➖ | Analysis models that produced a response in this fusion run, with each model's full panel content. | | -| `sources` | List[[components.FusionSource](../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](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputFusionServerToolItemType](../components/outputfusionservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `analysis` | [Optional[components.FusionAnalysisResult]](../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` | *Optional[str]* | :heavy_minus_sign: | Error message when the fusion run did not produce an analysis result. | | +| `failed_models` | List[[components.FailedModel](../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. | | +| `failure_reason` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `responses` | List[[components.OutputFusionServerToolItemResponse](../components/outputfusionservertoolitemresponse.mdx)] | :heavy_minus_sign: | Analysis models that produced a response in this fusion run, with each model's full panel content. | | +| `sources` | List[[components.FusionSource](../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](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputFusionServerToolItemType](../components/outputfusionservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputfusionservertoolitemresponse.mdx b/docs/components/outputfusionservertoolitemresponse.mdx index a3b2ea073..f7862f7dc 100644 --- a/docs/components/outputfusionservertoolitemresponse.mdx +++ b/docs/components/outputfusionservertoolitemresponse.mdx @@ -6,5 +6,5 @@ title: "OutputFusionServerToolItemResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `content` | *Optional[str]* | ➖ | N/A | -| `model` | *str* | ✅ | N/A | \ No newline at end of file +| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputimagegenerationcallitem.mdx b/docs/components/outputimagegenerationcallitem.mdx index 9f7a56ac9..f0148fb51 100644 --- a/docs/components/outputimagegenerationcallitem.mdx +++ b/docs/components/outputimagegenerationcallitem.mdx @@ -6,8 +6,8 @@ title: "OutputImageGenerationCallItem" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | | -| `result` | *OptionalNullable[str]* | ➖ | N/A | | -| `status` | [components.ImageGenerationStatus](../components/imagegenerationstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputImageGenerationCallItemType](../components/outputimagegenerationcallitemtype.mdx) | ✅ | N/A | | -| `prompt` | *Optional[str]* | ➖ | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | N/A | | +| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.ImageGenerationStatus](../components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputImageGenerationCallItemType](../components/outputimagegenerationcallitemtype.mdx) | :heavy_check_mark: | N/A | | +| `prompt` | *Optional[str]* | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file diff --git a/docs/components/outputimagegenerationservertoolitem.mdx b/docs/components/outputimagegenerationservertoolitem.mdx index a3dd0aeca..4b522ce89 100644 --- a/docs/components/outputimagegenerationservertoolitem.mdx +++ b/docs/components/outputimagegenerationservertoolitem.mdx @@ -9,12 +9,12 @@ An openrouter:image_generation server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | -| `image_b64` | *Optional[str]* | ➖ | N/A | | -| `image_url` | *Optional[str]* | ➖ | N/A | | -| `prompt` | *Optional[str]* | ➖ | The prompt (possibly rewritten) that the image was generated from. | | -| `result` | *OptionalNullable[str]* | ➖ | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | -| `revised_prompt` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputImageGenerationServerToolItemType](../components/outputimagegenerationservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `image_b64` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `prompt` | *Optional[str]* | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | +| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | +| `revised_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputImageGenerationServerToolItemType](../components/outputimagegenerationservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemapplypatchcall.mdx b/docs/components/outputitemapplypatchcall.mdx index 789dc5e80..a86389811 100644 --- a/docs/components/outputitemapplypatchcall.mdx +++ b/docs/components/outputitemapplypatchcall.mdx @@ -6,9 +6,9 @@ title: "OutputItemApplyPatchCall" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `call_id` | *str* | ✅ | N/A | -| `created_by` | *Optional[str]* | ➖ | N/A | -| `id` | *str* | ✅ | N/A | -| `operation` | [components.Operation](../components/operation.mdx) | ✅ | N/A | -| `status` | [components.OutputItemApplyPatchCallStatus](../components/outputitemapplypatchcallstatus.mdx) | ✅ | N/A | -| `type` | [components.OutputItemApplyPatchCallType](../components/outputitemapplypatchcalltype.mdx) | ✅ | N/A | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | +| `created_by` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `operation` | [components.Operation](../components/operation.mdx) | :heavy_check_mark: | N/A | +| `status` | [components.OutputItemApplyPatchCallStatus](../components/outputitemapplypatchcallstatus.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.OutputItemApplyPatchCallType](../components/outputitemapplypatchcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputitemcodeinterpretercall.mdx b/docs/components/outputitemcodeinterpretercall.mdx index b66d181aa..da739c3a2 100644 --- a/docs/components/outputitemcodeinterpretercall.mdx +++ b/docs/components/outputitemcodeinterpretercall.mdx @@ -6,10 +6,10 @@ title: "OutputItemCodeInterpreterCall" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *OptionalNullable[str]* | ➖ | N/A | | -| `container_id` | *Optional[str]* | ➖ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `outputs` | List[[components.OutputItemCodeInterpreterCallOutput](../components/outputitemcodeinterpretercalloutput.mdx)] | ➖ | N/A | | -| `status` | [components.OutputItemCodeInterpreterCallStatus](../components/outputitemcodeinterpretercallstatus.mdx) | ✅ | N/A | | -| `type` | [components.OutputItemCodeInterpreterCallType](../components/outputitemcodeinterpretercalltype.mdx) | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *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[str]* | :heavy_minus_sign: | N/A | | +| `container_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `outputs` | List[[components.OutputItemCodeInterpreterCallOutput](../components/outputitemcodeinterpretercalloutput.mdx)] | :heavy_minus_sign: | N/A | | +| `status` | [components.OutputItemCodeInterpreterCallStatus](../components/outputitemcodeinterpretercallstatus.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.OutputItemCodeInterpreterCallType](../components/outputitemcodeinterpretercalltype.mdx) | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/outputitemcustomtoolcall.mdx b/docs/components/outputitemcustomtoolcall.mdx index f45cc3cc6..1bc0ba739 100644 --- a/docs/components/outputitemcustomtoolcall.mdx +++ b/docs/components/outputitemcustomtoolcall.mdx @@ -6,11 +6,11 @@ title: "OutputItemCustomToolCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `async_` | *Optional[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 | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `input` | *str* | ✅ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.OutputItemCustomToolCallStatus]](../components/outputitemcustomtoolcallstatus.mdx) | ➖ | N/A | | -| `type` | [components.OutputItemCustomToolCallType](../components/outputitemcustomtoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `async_` | *Optional[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 | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `input` | *str* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.OutputItemCustomToolCallStatus]](../components/outputitemcustomtoolcallstatus.mdx) | :heavy_minus_sign: | N/A | | +| `type` | [components.OutputItemCustomToolCallType](../components/outputitemcustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemfilesearchcall.mdx b/docs/components/outputitemfilesearchcall.mdx index 4dc8873d9..5e9497c99 100644 --- a/docs/components/outputitemfilesearchcall.mdx +++ b/docs/components/outputitemfilesearchcall.mdx @@ -6,7 +6,7 @@ title: "OutputItemFileSearchCall" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | | -| `queries` | List[*str*] | ✅ | N/A | | -| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputItemFileSearchCallType](../components/outputitemfilesearchcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | N/A | | +| `queries` | List[*str*] | :heavy_check_mark: | N/A | | +| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputItemFileSearchCallType](../components/outputitemfilesearchcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemfunctioncall.mdx b/docs/components/outputitemfunctioncall.mdx index f835dedd6..d556439da 100644 --- a/docs/components/outputitemfunctioncall.mdx +++ b/docs/components/outputitemfunctioncall.mdx @@ -6,11 +6,11 @@ title: "OutputItemFunctionCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `arguments` | *str* | ✅ | N/A | | -| `async_` | *Optional[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 | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.OutputItemFunctionCallStatusUnion]](../components/outputitemfunctioncallstatusunion.mdx) | ➖ | N/A | | -| `type` | [components.OutputItemFunctionCallType](../components/outputitemfunctioncalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | | +| `async_` | *Optional[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 | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.OutputItemFunctionCallStatusUnion]](../components/outputitemfunctioncallstatusunion.mdx) | :heavy_minus_sign: | N/A | | +| `type` | [components.OutputItemFunctionCallType](../components/outputitemfunctioncalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemimagegenerationcall.mdx b/docs/components/outputitemimagegenerationcall.mdx index 3725ec33e..a9c86ddb3 100644 --- a/docs/components/outputitemimagegenerationcall.mdx +++ b/docs/components/outputitemimagegenerationcall.mdx @@ -6,7 +6,7 @@ title: "OutputItemImageGenerationCall" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | | -| `result` | *OptionalNullable[str]* | ➖ | N/A | | -| `status` | [components.ImageGenerationStatus](../components/imagegenerationstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputItemImageGenerationCallType](../components/outputitemimagegenerationcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | N/A | | +| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.ImageGenerationStatus](../components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputItemImageGenerationCallType](../components/outputitemimagegenerationcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemreasoning.mdx b/docs/components/outputitemreasoning.mdx index 218ed176d..1ea9da000 100644 --- a/docs/components/outputitemreasoning.mdx +++ b/docs/components/outputitemreasoning.mdx @@ -6,9 +6,9 @@ title: "OutputItemReasoning" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | ➖ | N/A | -| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | -| `id` | *str* | ✅ | N/A | -| `status` | [Optional[components.OutputItemReasoningStatusUnion]](../components/outputitemreasoningstatusunion.mdx) | ➖ | N/A | -| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | ✅ | N/A | -| `type` | [components.OutputItemReasoningType](../components/outputitemreasoningtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | +| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `status` | [Optional[components.OutputItemReasoningStatusUnion]](../components/outputitemreasoningstatusunion.mdx) | :heavy_minus_sign: | N/A | +| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | :heavy_check_mark: | N/A | +| `type` | [components.OutputItemReasoningType](../components/outputitemreasoningtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputitemwebsearchcall.mdx b/docs/components/outputitemwebsearchcall.mdx index cc322612b..9ff87e42a 100644 --- a/docs/components/outputitemwebsearchcall.mdx +++ b/docs/components/outputitemwebsearchcall.mdx @@ -6,8 +6,8 @@ title: "OutputItemWebSearchCall" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [Optional[components.OutputItemWebSearchCallActionUnion]](../components/outputitemwebsearchcallactionunion.mdx) | ➖ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputItemWebSearchCallTypeWebSearchCall](../components/outputitemwebsearchcalltypewebsearchcall.mdx) | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *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` | [Optional[components.OutputItemWebSearchCallActionUnion]](../components/outputitemwebsearchcallactionunion.mdx) | :heavy_minus_sign: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputItemWebSearchCallTypeWebSearchCall](../components/outputitemwebsearchcalltypewebsearchcall.mdx) | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/outputitemwebsearchcallactionfindinpage.mdx b/docs/components/outputitemwebsearchcallactionfindinpage.mdx index 814cdb44b..4799afedd 100644 --- a/docs/components/outputitemwebsearchcallactionfindinpage.mdx +++ b/docs/components/outputitemwebsearchcallactionfindinpage.mdx @@ -6,6 +6,6 @@ title: "OutputItemWebSearchCallActionFindInPage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `pattern` | *str* | ✅ | N/A | -| `type` | [components.OutputItemWebSearchCallTypeFindInPage](../components/outputitemwebsearchcalltypefindinpage.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `pattern` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.OutputItemWebSearchCallTypeFindInPage](../components/outputitemwebsearchcalltypefindinpage.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputitemwebsearchcallactionopenpage.mdx b/docs/components/outputitemwebsearchcallactionopenpage.mdx index c4219877e..12b280f5d 100644 --- a/docs/components/outputitemwebsearchcallactionopenpage.mdx +++ b/docs/components/outputitemwebsearchcallactionopenpage.mdx @@ -6,5 +6,5 @@ title: "OutputItemWebSearchCallActionOpenPage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `type` | [components.OutputItemWebSearchCallTypeOpenPage](../components/outputitemwebsearchcalltypeopenpage.mdx) | ✅ | N/A | -| `url` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file +| `type` | [components.OutputItemWebSearchCallTypeOpenPage](../components/outputitemwebsearchcalltypeopenpage.mdx) | :heavy_check_mark: | N/A | +| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/outputitemwebsearchcallactionsearch.mdx b/docs/components/outputitemwebsearchcallactionsearch.mdx index 12f6d4a14..c747e378a 100644 --- a/docs/components/outputitemwebsearchcallactionsearch.mdx +++ b/docs/components/outputitemwebsearchcallactionsearch.mdx @@ -6,7 +6,7 @@ title: "OutputItemWebSearchCallActionSearch" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `queries` | List[*str*] | ➖ | N/A | -| `query` | *str* | ✅ | N/A | -| `sources` | List[[components.WebSearchSource](../components/websearchsource.mdx)] | ➖ | N/A | -| `type` | [components.OutputItemWebSearchCallTypeSearch](../components/outputitemwebsearchcalltypesearch.mdx) | ✅ | N/A | \ No newline at end of file +| `queries` | List[*str*] | :heavy_minus_sign: | N/A | +| `query` | *str* | :heavy_check_mark: | N/A | +| `sources` | List[[components.WebSearchSource](../components/websearchsource.mdx)] | :heavy_minus_sign: | N/A | +| `type` | [components.OutputItemWebSearchCallTypeSearch](../components/outputitemwebsearchcalltypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputmcpservertoolitem.mdx b/docs/components/outputmcpservertoolitem.mdx index 0765d532b..d11d1e776 100644 --- a/docs/components/outputmcpservertoolitem.mdx +++ b/docs/components/outputmcpservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:mcp server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | ➖ | N/A | | -| `server_label` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `tool_name` | *Optional[str]* | ➖ | N/A | | -| `type` | [components.OutputMcpServerToolItemType](../components/outputmcpservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `server_label` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `tool_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.OutputMcpServerToolItemType](../components/outputmcpservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputmemoryservertoolitem.mdx b/docs/components/outputmemoryservertoolitem.mdx index b44e3d109..57345928f 100644 --- a/docs/components/outputmemoryservertoolitem.mdx +++ b/docs/components/outputmemoryservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:memory server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `action` | [Optional[components.ActionEnum]](../components/actionenum.mdx) | ➖ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `key` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputMemoryServerToolItemType](../components/outputmemoryservertoolitemtype.mdx) | ✅ | N/A | | -| `value` | *Optional[Any]* | ➖ | N/A | | \ No newline at end of file +| `action` | [Optional[components.ActionEnum]](../components/actionenum.mdx) | :heavy_minus_sign: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputMemoryServerToolItemType](../components/outputmemoryservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | +| `value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/outputmessage.mdx b/docs/components/outputmessage.mdx index 7020a531d..9cd8a403f 100644 --- a/docs/components/outputmessage.mdx +++ b/docs/components/outputmessage.mdx @@ -6,9 +6,9 @@ title: "OutputMessage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.OutputMessageContent](../components/outputmessagecontent.mdx)] | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `phase` | [OptionalNullable[components.OutputMessagePhaseUnion]](../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](../components/outputmessagerole.mdx) | ✅ | N/A | -| `status` | [Optional[components.OutputMessageStatusUnion]](../components/outputmessagestatusunion.mdx) | ➖ | N/A | -| `type` | [components.OutputMessageType](../components/outputmessagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | List[[components.OutputMessageContent](../components/outputmessagecontent.mdx)] | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `phase` | [OptionalNullable[components.OutputMessagePhaseUnion]](../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](../components/outputmessagerole.mdx) | :heavy_check_mark: | N/A | +| `status` | [Optional[components.OutputMessageStatusUnion]](../components/outputmessagestatusunion.mdx) | :heavy_minus_sign: | N/A | +| `type` | [components.OutputMessageType](../components/outputmessagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputmessageitem.mdx b/docs/components/outputmessageitem.mdx index b8d199b6f..f02e8d23c 100644 --- a/docs/components/outputmessageitem.mdx +++ b/docs/components/outputmessageitem.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.OutputMessageItemContent](../components/outputmessageitemcontent.mdx)] | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `phase` | [OptionalNullable[components.OutputMessageItemPhaseUnion]](../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](../components/outputmessageitemrole.mdx) | ✅ | N/A | -| `status` | [Optional[components.OutputMessageItemStatusUnion]](../components/outputmessageitemstatusunion.mdx) | ➖ | N/A | -| `type` | [components.OutputMessageItemType](../components/outputmessageitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | List[[components.OutputMessageItemContent](../components/outputmessageitemcontent.mdx)] | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `phase` | [OptionalNullable[components.OutputMessageItemPhaseUnion]](../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](../components/outputmessageitemrole.mdx) | :heavy_check_mark: | N/A | +| `status` | [Optional[components.OutputMessageItemStatusUnion]](../components/outputmessageitemstatusunion.mdx) | :heavy_minus_sign: | N/A | +| `type` | [components.OutputMessageItemType](../components/outputmessageitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputreasoningitem.mdx b/docs/components/outputreasoningitem.mdx index e150ddac8..761085bfa 100644 --- a/docs/components/outputreasoningitem.mdx +++ b/docs/components/outputreasoningitem.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | ➖ | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `status` | [Optional[components.OutputReasoningItemStatusUnion]](../components/outputreasoningitemstatusunion.mdx) | ➖ | N/A | | -| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | ✅ | N/A | | -| `type` | [components.OutputReasoningItemType](../components/outputreasoningitemtype.mdx) | ✅ | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | -| `signature` | *OptionalNullable[str]* | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `status` | [Optional[components.OutputReasoningItemStatusUnion]](../components/outputreasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | +| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | :heavy_check_mark: | N/A | | +| `type` | [components.OutputReasoningItemType](../components/outputreasoningitemtype.mdx) | :heavy_check_mark: | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/components/outputsearchmodelsservertoolitem.mdx b/docs/components/outputsearchmodelsservertoolitem.mdx index 07583af41..0ee05cf72 100644 --- a/docs/components/outputsearchmodelsservertoolitem.mdx +++ b/docs/components/outputsearchmodelsservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:experimental__search_models server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *Optional[str]* | ➖ | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | -| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | -| `query` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputSearchModelsServerToolItemType](../components/outputsearchmodelsservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *Optional[str]* | :heavy_minus_sign: | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | +| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputSearchModelsServerToolItemType](../components/outputsearchmodelsservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputshellcallitem.mdx b/docs/components/outputshellcallitem.mdx index a340e0b89..6c6d71643 100644 --- a/docs/components/outputshellcallitem.mdx +++ b/docs/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` | [Optional[components.OutputShellCallItemAction]](../components/outputshellcallitemaction.mdx) | ➖ | N/A | | -| `arguments` | *OptionalNullable[str]* | ➖ | 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. | | -| `call_id` | *str* | ✅ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `status` | [components.ShellCallStatus](../components/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | -| `type` | [components.OutputShellCallItemType](../components/outputshellcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `action` | [Optional[components.OutputShellCallItemAction]](../components/outputshellcallitemaction.mdx) | :heavy_minus_sign: | N/A | | +| `arguments` | *OptionalNullable[str]* | :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. | | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `status` | [components.ShellCallStatus](../components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | +| `type` | [components.OutputShellCallItemType](../components/outputshellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputshellcallitemaction.mdx b/docs/components/outputshellcallitemaction.mdx index b225a6206..2e9c76f3d 100644 --- a/docs/components/outputshellcallitemaction.mdx +++ b/docs/components/outputshellcallitemaction.mdx @@ -6,6 +6,6 @@ title: "OutputShellCallItemAction" | Field | Type | Required | Description | | ------------------- | ------------------- | ------------------- | ------------------- | -| `commands` | List[*str*] | ✅ | N/A | -| `max_output_length` | *Nullable[int]* | ✅ | N/A | -| `timeout_ms` | *Nullable[int]* | ✅ | N/A | \ No newline at end of file +| `commands` | List[*str*] | :heavy_check_mark: | N/A | +| `max_output_length` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `timeout_ms` | *Nullable[int]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputshellcalloutputitem.mdx b/docs/components/outputshellcalloutputitem.mdx index 42388960f..eb07476e3 100644 --- a/docs/components/outputshellcalloutputitem.mdx +++ b/docs/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 | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | ✅ | N/A | | -| `container_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | List[[components.OutputShellCallOutputItemFile](../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` | *str* | ✅ | N/A | | -| `max_output_length` | *OptionalNullable[int]* | ➖ | N/A | | -| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | ✅ | N/A | | -| `status` | [components.ShellCallStatus](../components/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | -| `type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../components/outputshellcalloutputitemtypeshellcalloutput.mdx) | ✅ | N/A | | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `container_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | List[[components.OutputShellCallOutputItemFile](../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` | *str* | :heavy_check_mark: | N/A | | +| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | :heavy_check_mark: | N/A | | +| `status` | [components.ShellCallStatus](../components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | +| `type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../components/outputshellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputshellcalloutputitemfile.mdx b/docs/components/outputshellcalloutputitemfile.mdx index b289b18b4..5abec4933 100644 --- a/docs/components/outputshellcalloutputitemfile.mdx +++ b/docs/components/outputshellcalloutputitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputShellCallOutputItemFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | ✅ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `file_id` | *str* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `type` | [components.OutputShellCallOutputItemTypeContainerFileCitation](../components/outputshellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *str* | :heavy_check_mark: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.OutputShellCallOutputItemTypeContainerFileCitation](../components/outputshellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputshellservertoolitem.mdx b/docs/components/outputshellservertoolitem.mdx index 6c601392f..0f0bbc33c 100644 --- a/docs/components/outputshellservertoolitem.mdx +++ b/docs/components/outputshellservertoolitem.mdx @@ -9,13 +9,13 @@ An openrouter:shell server tool output item | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [Optional[components.OutputShellServerToolItemAction]](../components/outputshellservertoolitemaction.mdx) | ➖ | N/A | | -| `arguments` | *OptionalNullable[str]* | ➖ | The raw tool-call arguments string as emitted by the model. | | -| `call_id` | *OptionalNullable[str]* | ➖ | The model-generated tool call id from the originating turn. | | -| `container_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | List[[components.OutputShellServerToolItemFile](../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` | *Optional[str]* | ➖ | N/A | | -| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | ➖ | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputShellServerToolItemTypeOpenrouterShell](../components/outputshellservertoolitemtypeopenroutershell.mdx) | ✅ | N/A | | \ No newline at end of file +| `action` | [Optional[components.OutputShellServerToolItemAction]](../components/outputshellservertoolitemaction.mdx) | :heavy_minus_sign: | N/A | | +| `arguments` | *OptionalNullable[str]* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | +| `call_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | +| `container_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | List[[components.OutputShellServerToolItemFile](../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputShellServerToolItemTypeOpenrouterShell](../components/outputshellservertoolitemtypeopenroutershell.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputshellservertoolitemaction.mdx b/docs/components/outputshellservertoolitemaction.mdx index 7397736af..56f9a9add 100644 --- a/docs/components/outputshellservertoolitemaction.mdx +++ b/docs/components/outputshellservertoolitemaction.mdx @@ -6,6 +6,6 @@ title: "OutputShellServerToolItemAction" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `commands` | List[*str*] | ✅ | N/A | -| `max_output_length` | *OptionalNullable[int]* | ➖ | N/A | -| `timeout_ms` | *OptionalNullable[int]* | ➖ | N/A | \ No newline at end of file +| `commands` | List[*str*] | :heavy_check_mark: | N/A | +| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | +| `timeout_ms` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/outputshellservertoolitemfile.mdx b/docs/components/outputshellservertoolitemfile.mdx index 93b99738f..699a13178 100644 --- a/docs/components/outputshellservertoolitemfile.mdx +++ b/docs/components/outputshellservertoolitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputShellServerToolItemFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | ✅ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `file_id` | *str* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `type` | [components.OutputShellServerToolItemTypeContainerFileCitation](../components/outputshellservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *str* | :heavy_check_mark: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.OutputShellServerToolItemTypeContainerFileCitation](../components/outputshellservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputsubagentservertoolitem.mdx b/docs/components/outputsubagentservertoolitem.mdx index bccce611d..b9f3820a1 100644 --- a/docs/components/outputsubagentservertoolitem.mdx +++ b/docs/components/outputsubagentservertoolitem.mdx @@ -9,14 +9,14 @@ An openrouter:subagent server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `instance_name` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Slug of the worker model that executed the task. | | -| `name` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | The worker model's result (the outcome text returned to the delegating model). | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `task_description` | *Optional[str]* | ➖ | The task description the delegating model sent to the worker. | | -| `task_name` | *Optional[str]* | ➖ | The short task identifier the delegating model supplied. | | -| `type` | [components.OutputSubagentServerToolItemType](../components/outputsubagentservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `call_id` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `instance_name` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Slug of the worker model that executed the task. | | +| `name` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | The worker model's result (the outcome text returned to the delegating model). | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `task_description` | *Optional[str]* | :heavy_minus_sign: | The task description the delegating model sent to the worker. | | +| `task_name` | *Optional[str]* | :heavy_minus_sign: | The short task identifier the delegating model supplied. | | +| `type` | [components.OutputSubagentServerToolItemType](../components/outputsubagentservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputtexteditorservertoolitem.mdx b/docs/components/outputtexteditorservertoolitem.mdx index f10b6020e..2739149f3 100644 --- a/docs/components/outputtexteditorservertoolitem.mdx +++ b/docs/components/outputtexteditorservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:text_editor server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `command` | [Optional[components.Command]](../components/command.mdx) | ➖ | N/A | | -| `file_path` | *Optional[str]* | ➖ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputTextEditorServerToolItemType](../components/outputtexteditorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `command` | [Optional[components.Command]](../components/command.mdx) | :heavy_minus_sign: | N/A | | +| `file_path` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputTextEditorServerToolItemType](../components/outputtexteditorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputtokensdetails.mdx b/docs/components/outputtokensdetails.mdx index a3f183f72..9c9b6d592 100644 --- a/docs/components/outputtokensdetails.mdx +++ b/docs/components/outputtokensdetails.mdx @@ -6,4 +6,4 @@ title: "OutputTokensDetails" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `reasoning_tokens` | *int* | ✅ | N/A | \ No newline at end of file +| `reasoning_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputtoolsearchcallitem.mdx b/docs/components/outputtoolsearchcallitem.mdx index ac0b9bb91..c12730c02 100644 --- a/docs/components/outputtoolsearchcallitem.mdx +++ b/docs/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` | *Optional[Any]* | ➖ | N/A | | -| `call_id` | *str* | ✅ | N/A | | -| `execution` | [components.OutputToolSearchCallItemExecution](../components/outputtoolsearchcallitemexecution.mdx) | ✅ | N/A | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputToolSearchCallItemType](../components/outputtoolsearchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `execution` | [components.OutputToolSearchCallItemExecution](../components/outputtoolsearchcallitemexecution.mdx) | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputToolSearchCallItemType](../components/outputtoolsearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputtoolsearchservertoolitem.mdx b/docs/components/outputtoolsearchservertoolitem.mdx index b3bf9c0bb..8b20ba5e8 100644 --- a/docs/components/outputtoolsearchservertoolitem.mdx +++ b/docs/components/outputtoolsearchservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:tool_search server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | -| `matches` | List[[components.Match](../components/match.mdx)] | ➖ | N/A | | -| `query` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputToolSearchServerToolItemType](../components/outputtoolsearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `matches` | List[[components.Match](../components/match.mdx)] | :heavy_minus_sign: | N/A | | +| `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputToolSearchServerToolItemType](../components/outputtoolsearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputwebfetchservertoolitem.mdx b/docs/components/outputwebfetchservertoolitem.mdx index 888a84f5f..9c045b8b4 100644 --- a/docs/components/outputwebfetchservertoolitem.mdx +++ b/docs/components/outputwebfetchservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:web_fetch server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `content` | *Optional[str]* | ➖ | N/A | | -| `error` | *Optional[str]* | ➖ | The error message if the fetch failed. | | -| `http_status` | *Optional[int]* | ➖ | The HTTP status code returned by the upstream URL fetch. | | -| `id` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `title` | *Optional[str]* | ➖ | N/A | | -| `type` | [components.OutputWebFetchServerToolItemType](../components/outputwebfetchservertoolitemtype.mdx) | ✅ | N/A | | -| `url` | *Optional[str]* | ➖ | N/A | | \ No newline at end of file +| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error` | *Optional[str]* | :heavy_minus_sign: | The error message if the fetch failed. | | +| `http_status` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.OutputWebFetchServerToolItemType](../components/outputwebfetchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | +| `url` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/outputwebsearchcallitem.mdx b/docs/components/outputwebsearchcallitem.mdx index cdf94d40f..01c05d15b 100644 --- a/docs/components/outputwebsearchcallitem.mdx +++ b/docs/components/outputwebsearchcallitem.mdx @@ -6,8 +6,8 @@ title: "OutputWebSearchCallItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [Optional[components.OutputWebSearchCallItemActionUnion]](../components/outputwebsearchcallitemactionunion.mdx) | ➖ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputWebSearchCallItemTypeWebSearchCall](../components/outputwebsearchcallitemtypewebsearchcall.mdx) | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *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` | [Optional[components.OutputWebSearchCallItemActionUnion]](../components/outputwebsearchcallitemactionunion.mdx) | :heavy_minus_sign: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputWebSearchCallItemTypeWebSearchCall](../components/outputwebsearchcallitemtypewebsearchcall.mdx) | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/outputwebsearchcallitemactionfindinpage.mdx b/docs/components/outputwebsearchcallitemactionfindinpage.mdx index 4561c8a5d..34fdc6f81 100644 --- a/docs/components/outputwebsearchcallitemactionfindinpage.mdx +++ b/docs/components/outputwebsearchcallitemactionfindinpage.mdx @@ -6,6 +6,6 @@ title: "OutputWebSearchCallItemActionFindInPage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `pattern` | *str* | ✅ | N/A | -| `type` | [components.OutputWebSearchCallItemTypeFindInPage](../components/outputwebsearchcallitemtypefindinpage.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `pattern` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.OutputWebSearchCallItemTypeFindInPage](../components/outputwebsearchcallitemtypefindinpage.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputwebsearchcallitemactionopenpage.mdx b/docs/components/outputwebsearchcallitemactionopenpage.mdx index a957aceb8..020201843 100644 --- a/docs/components/outputwebsearchcallitemactionopenpage.mdx +++ b/docs/components/outputwebsearchcallitemactionopenpage.mdx @@ -6,5 +6,5 @@ title: "OutputWebSearchCallItemActionOpenPage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `type` | [components.OutputWebSearchCallItemTypeOpenPage](../components/outputwebsearchcallitemtypeopenpage.mdx) | ✅ | N/A | -| `url` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file +| `type` | [components.OutputWebSearchCallItemTypeOpenPage](../components/outputwebsearchcallitemtypeopenpage.mdx) | :heavy_check_mark: | N/A | +| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/outputwebsearchcallitemactionsearch.mdx b/docs/components/outputwebsearchcallitemactionsearch.mdx index 063b6c29f..3e4513ec3 100644 --- a/docs/components/outputwebsearchcallitemactionsearch.mdx +++ b/docs/components/outputwebsearchcallitemactionsearch.mdx @@ -6,7 +6,7 @@ title: "OutputWebSearchCallItemActionSearch" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `queries` | List[*str*] | ➖ | N/A | -| `query` | *str* | ✅ | N/A | -| `sources` | List[[components.WebSearchSource](../components/websearchsource.mdx)] | ➖ | N/A | -| `type` | [components.OutputWebSearchCallItemTypeSearch](../components/outputwebsearchcallitemtypesearch.mdx) | ✅ | N/A | \ No newline at end of file +| `queries` | List[*str*] | :heavy_minus_sign: | N/A | +| `query` | *str* | :heavy_check_mark: | N/A | +| `sources` | List[[components.WebSearchSource](../components/websearchsource.mdx)] | :heavy_minus_sign: | N/A | +| `type` | [components.OutputWebSearchCallItemTypeSearch](../components/outputwebsearchcallitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputwebsearchservertoolitem.mdx b/docs/components/outputwebsearchservertoolitem.mdx index 2e1dc4a0c..0b1a60766 100644 --- a/docs/components/outputwebsearchservertoolitem.mdx +++ b/docs/components/outputwebsearchservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:web_search server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `action` | [Optional[components.OutputWebSearchServerToolItemAction]](../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | ✅ | N/A | | \ No newline at end of file +| `action` | [Optional[components.OutputWebSearchServerToolItemAction]](../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` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/outputwebsearchservertoolitemaction.mdx b/docs/components/outputwebsearchservertoolitemaction.mdx index 9b0834971..ca6a895cf 100644 --- a/docs/components/outputwebsearchservertoolitemaction.mdx +++ b/docs/components/outputwebsearchservertoolitemaction.mdx @@ -9,6 +9,6 @@ The search action performed, matching OpenAI web_search_call.action shape. Inclu | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `query` | *str* | ✅ | N/A | -| `sources` | List[[components.OutputWebSearchServerToolItemSource](../components/outputwebsearchservertoolitemsource.mdx)] | ➖ | N/A | -| `type` | [components.OutputWebSearchServerToolItemTypeSearch](../components/outputwebsearchservertoolitemtypesearch.mdx) | ✅ | N/A | \ No newline at end of file +| `query` | *str* | :heavy_check_mark: | N/A | +| `sources` | List[[components.OutputWebSearchServerToolItemSource](../components/outputwebsearchservertoolitemsource.mdx)] | :heavy_minus_sign: | N/A | +| `type` | [components.OutputWebSearchServerToolItemTypeSearch](../components/outputwebsearchservertoolitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/outputwebsearchservertoolitemsource.mdx b/docs/components/outputwebsearchservertoolitemsource.mdx index 3cf7735a4..5c1f410d3 100644 --- a/docs/components/outputwebsearchservertoolitemsource.mdx +++ b/docs/components/outputwebsearchservertoolitemsource.mdx @@ -6,5 +6,5 @@ title: "OutputWebSearchServerToolItemSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.OutputWebSearchServerToolItemTypeURL](../components/outputwebsearchservertoolitemtypeurl.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `type` | [components.OutputWebSearchServerToolItemTypeURL](../components/outputwebsearchservertoolitemtypeurl.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/paretorouterplugin.mdx b/docs/components/paretorouterplugin.mdx index 719eb6134..94e222c89 100644 --- a/docs/components/paretorouterplugin.mdx +++ b/docs/components/paretorouterplugin.mdx @@ -6,8 +6,8 @@ title: "ParetoRouterPlugin" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | ➖ | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | -| `id` | [components.ParetoRouterPluginID](../components/paretorouterpluginid.mdx) | ✅ | N/A | | -| `max_price` | *Optional[float]* | ➖ | 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 | -| `min_coding_score` | *Optional[float]* | ➖ | 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 | -| `price_source` | [Optional[components.PriceSource]](../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` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | +| `id` | [components.ParetoRouterPluginID](../components/paretorouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `max_price` | *Optional[float]* | :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 | +| `min_coding_score` | *Optional[float]* | :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 | +| `price_source` | [Optional[components.PriceSource]](../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/components/partialcoverage.mdx b/docs/components/partialcoverage.mdx index 94b02d263..7c7807b23 100644 --- a/docs/components/partialcoverage.mdx +++ b/docs/components/partialcoverage.mdx @@ -6,5 +6,5 @@ title: "PartialCoverage" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `models` | List[*str*] | ✅ | N/A | -| `point` | *str* | ✅ | N/A | \ No newline at end of file +| `models` | List[*str*] | :heavy_check_mark: | N/A | +| `point` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/payloadtoolargeresponseerrordata.mdx b/docs/components/payloadtoolargeresponseerrordata.mdx index e5133395a..bb7c7f6be 100644 --- a/docs/components/payloadtoolargeresponseerrordata.mdx +++ b/docs/components/payloadtoolargeresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for PayloadTooLargeResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/paymentrequiredresponseerrordata.mdx b/docs/components/paymentrequiredresponseerrordata.mdx index 3827ce4ae..225e28808 100644 --- a/docs/components/paymentrequiredresponseerrordata.mdx +++ b/docs/components/paymentrequiredresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for PaymentRequiredResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/pdfparseroptions.mdx b/docs/components/pdfparseroptions.mdx index 4f250cf60..2e8305209 100644 --- a/docs/components/pdfparseroptions.mdx +++ b/docs/components/pdfparseroptions.mdx @@ -9,4 +9,4 @@ Options for PDF parsing. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.PDFParserEngine]](../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` | [Optional[components.PDFParserEngine]](../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/components/pendingsafetycheck.mdx b/docs/components/pendingsafetycheck.mdx index 55ed485aa..4d484ee8e 100644 --- a/docs/components/pendingsafetycheck.mdx +++ b/docs/components/pendingsafetycheck.mdx @@ -6,6 +6,6 @@ title: "PendingSafetyCheck" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *str* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | \ No newline at end of file +| `code` | *str* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/percentilelatencycutoffs.mdx b/docs/components/percentilelatencycutoffs.mdx index 62cbd38e3..60b8ab278 100644 --- a/docs/components/percentilelatencycutoffs.mdx +++ b/docs/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[float]* | ➖ | Maximum p50 latency (seconds) | -| `p75` | *OptionalNullable[float]* | ➖ | Maximum p75 latency (seconds) | -| `p90` | *OptionalNullable[float]* | ➖ | Maximum p90 latency (seconds) | -| `p99` | *OptionalNullable[float]* | ➖ | Maximum p99 latency (seconds) | \ No newline at end of file +| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p50 latency (seconds) | +| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p75 latency (seconds) | +| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p90 latency (seconds) | +| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/docs/components/percentilestats.mdx b/docs/components/percentilestats.mdx index eff62d28b..ff5277c9c 100644 --- a/docs/components/percentilestats.mdx +++ b/docs/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` | *float* | ✅ | Median (50th percentile) | 25.5 | -| `p75` | *float* | ✅ | 75th percentile | 35.2 | -| `p90` | *float* | ✅ | 90th percentile | 48.7 | -| `p99` | *float* | ✅ | 99th percentile | 85.3 | \ No newline at end of file +| `p50` | *float* | :heavy_check_mark: | Median (50th percentile) | 25.5 | +| `p75` | *float* | :heavy_check_mark: | 75th percentile | 35.2 | +| `p90` | *float* | :heavy_check_mark: | 90th percentile | 48.7 | +| `p99` | *float* | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file diff --git a/docs/components/percentilethroughputcutoffs.mdx b/docs/components/percentilethroughputcutoffs.mdx index fac1d15bc..86ea31294 100644 --- a/docs/components/percentilethroughputcutoffs.mdx +++ b/docs/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[float]* | ➖ | Minimum p50 throughput (tokens/sec) | -| `p75` | *OptionalNullable[float]* | ➖ | Minimum p75 throughput (tokens/sec) | -| `p90` | *OptionalNullable[float]* | ➖ | Minimum p90 throughput (tokens/sec) | -| `p99` | *OptionalNullable[float]* | ➖ | Minimum p99 throughput (tokens/sec) | \ No newline at end of file +| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | +| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | +| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | +| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/docs/components/perflast30mbyworkload.mdx b/docs/components/perflast30mbyworkload.mdx index fcb436a59..193447130 100644 --- a/docs/components/perflast30mbyworkload.mdx +++ b/docs/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` | [Optional[components.Decisions]](../components/decisions.mdx) | ➖ | N/A | -| `embeddings` | [Optional[components.Embeddings]](../components/embeddings.mdx) | ➖ | N/A | -| `image_generation` | [Optional[components.ImageGeneration]](../components/imagegeneration.mdx) | ➖ | N/A | -| `rerank` | [Optional[components.Rerank]](../components/rerank.mdx) | ➖ | N/A | -| `stt` | [Optional[components.STT]](../components/stt.mdx) | ➖ | N/A | -| `text_generation` | [Optional[components.TextGeneration]](../components/textgeneration.mdx) | ➖ | N/A | -| `tts` | [Optional[components.TTS]](../components/tts.mdx) | ➖ | N/A | -| `unknown` | [Optional[components.Unknown]](../components/unknown.mdx) | ➖ | N/A | -| `video_generation` | [Optional[components.VideoGeneration]](../components/videogeneration.mdx) | ➖ | N/A | \ No newline at end of file +| `decisions` | [Optional[components.Decisions]](../components/decisions.mdx) | :heavy_minus_sign: | N/A | +| `embeddings` | [Optional[components.Embeddings]](../components/embeddings.mdx) | :heavy_minus_sign: | N/A | +| `image_generation` | [Optional[components.ImageGeneration]](../components/imagegeneration.mdx) | :heavy_minus_sign: | N/A | +| `rerank` | [Optional[components.Rerank]](../components/rerank.mdx) | :heavy_minus_sign: | N/A | +| `stt` | [Optional[components.STT]](../components/stt.mdx) | :heavy_minus_sign: | N/A | +| `text_generation` | [Optional[components.TextGeneration]](../components/textgeneration.mdx) | :heavy_minus_sign: | N/A | +| `tts` | [Optional[components.TTS]](../components/tts.mdx) | :heavy_minus_sign: | N/A | +| `unknown` | [Optional[components.Unknown]](../components/unknown.mdx) | :heavy_minus_sign: | N/A | +| `video_generation` | [Optional[components.VideoGeneration]](../components/videogeneration.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/perrequestlimits.mdx b/docs/components/perrequestlimits.mdx index 9b1550fb9..c03fb6fb6 100644 --- a/docs/components/perrequestlimits.mdx +++ b/docs/components/perrequestlimits.mdx @@ -9,5 +9,5 @@ Per-request token limits | Field | Type | Required | Description | Example | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `completion_tokens` | *float* | ✅ | Maximum completion tokens per request | 1000 | -| `prompt_tokens` | *float* | ✅ | Maximum prompt tokens per request | 1000 | \ No newline at end of file +| `completion_tokens` | *float* | :heavy_check_mark: | Maximum completion tokens per request | 1000 | +| `prompt_tokens` | *float* | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | \ No newline at end of file diff --git a/docs/components/pipelinestage.mdx b/docs/components/pipelinestage.mdx index 2966e9054..2f7a26c02 100644 --- a/docs/components/pipelinestage.mdx +++ b/docs/components/pipelinestage.mdx @@ -6,10 +6,10 @@ title: "PipelineStage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cost_usd` | *OptionalNullable[float]* | ➖ | N/A | | -| `data` | Dict[str, *Any*] | ➖ | N/A | | -| `guardrail_id` | *Optional[str]* | ➖ | N/A | | -| `guardrail_scope` | *Optional[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `summary` | *Optional[str]* | ➖ | N/A | | -| `type` | [components.PipelineStageType](../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 +| `cost_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `data` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `guardrail_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `guardrail_scope` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.PipelineStageType](../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/components/prediction.mdx b/docs/components/prediction.mdx index 89ba5ec28..6164a9fa7 100644 --- a/docs/components/prediction.mdx +++ b/docs/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](../components/predictioncontent.mdx) | ✅ | N/A | -| `type` | [components.PredictionType](../components/predictiontype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | [components.PredictionContent](../components/predictioncontent.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.PredictionType](../components/predictiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/predictioncontenttext.mdx b/docs/components/predictioncontenttext.mdx index ddd01c9e0..541026eaa 100644 --- a/docs/components/predictioncontenttext.mdx +++ b/docs/components/predictioncontenttext.mdx @@ -9,5 +9,5 @@ Text content part for a predicted output. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `text` | *str* | ✅ | N/A | -| `type` | [components.PredictionContentTextType](../components/predictioncontenttexttype.mdx) | ✅ | N/A | \ No newline at end of file +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.PredictionContentTextType](../components/predictioncontenttexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/preset.mdx b/docs/components/preset.mdx index 7d4874e2f..af18885fe 100644 --- a/docs/components/preset.mdx +++ b/docs/components/preset.mdx @@ -9,14 +9,14 @@ A preset without version details. | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `created_at` | *str* | ✅ | N/A | | -| `creator_user_id` | *Nullable[str]* | ✅ | N/A | | -| `description` | *Nullable[str]* | ✅ | N/A | | -| `designated_version_id` | *Nullable[str]* | ✅ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `slug` | *str* | ✅ | N/A | | -| `status` | [components.PresetStatus](../components/presetstatus.mdx) | ✅ | The status of a preset. | active | -| `status_updated_at` | *Nullable[str]* | ✅ | N/A | | -| `updated_at` | *str* | ✅ | N/A | | -| `workspace_id` | *Nullable[str]* | ✅ | N/A | | \ No newline at end of file +| `created_at` | *str* | :heavy_check_mark: | N/A | | +| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `description` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `designated_version_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `slug` | *str* | :heavy_check_mark: | N/A | | +| `status` | [components.PresetStatus](../components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | +| `status_updated_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | N/A | | +| `workspace_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/presetdesignatedversion.mdx b/docs/components/presetdesignatedversion.mdx index 50a127bac..5c5675bea 100644 --- a/docs/components/presetdesignatedversion.mdx +++ b/docs/components/presetdesignatedversion.mdx @@ -9,11 +9,11 @@ A specific version of a preset, containing config and optional system prompt. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `config` | Dict[str, *Any*] | ✅ | N/A | -| `created_at` | *str* | ✅ | N/A | -| `creator_id` | *str* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `preset_id` | *str* | ✅ | N/A | -| `system_prompt` | *Nullable[str]* | ✅ | N/A | -| `updated_at` | *str* | ✅ | N/A | -| `version` | *int* | ✅ | N/A | \ No newline at end of file +| `config` | Dict[str, *Any*] | :heavy_check_mark: | N/A | +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `creator_id` | *str* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `preset_id` | *str* | :heavy_check_mark: | N/A | +| `system_prompt` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `version` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/presetwithdesignatedversion.mdx b/docs/components/presetwithdesignatedversion.mdx index 442a603f9..56d189d99 100644 --- a/docs/components/presetwithdesignatedversion.mdx +++ b/docs/components/presetwithdesignatedversion.mdx @@ -9,15 +9,15 @@ A preset with its currently designated version. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | ✅ | N/A | | -| `creator_user_id` | *Nullable[str]* | ✅ | N/A | | -| `description` | *Nullable[str]* | ✅ | N/A | | -| `designated_version_id` | *Nullable[str]* | ✅ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `slug` | *str* | ✅ | N/A | | -| `status` | [components.PresetStatus](../components/presetstatus.mdx) | ✅ | The status of a preset. | active | -| `status_updated_at` | *Nullable[str]* | ✅ | N/A | | -| `updated_at` | *str* | ✅ | N/A | | -| `workspace_id` | *Nullable[str]* | ✅ | N/A | | -| `designated_version` | [Nullable[components.PresetDesignatedVersion]](../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 +| `created_at` | *str* | :heavy_check_mark: | N/A | | +| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `description` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `designated_version_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `slug` | *str* | :heavy_check_mark: | N/A | | +| `status` | [components.PresetStatus](../components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | +| `status_updated_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `updated_at` | *str* | :heavy_check_mark: | N/A | | +| `workspace_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `designated_version` | [Nullable[components.PresetDesignatedVersion]](../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/components/preview20250311websearchservertool.mdx b/docs/components/preview20250311websearchservertool.mdx index 7931387fd..750580a39 100644 --- a/docs/components/preview20250311websearchservertool.mdx +++ b/docs/components/preview20250311websearchservertool.mdx @@ -9,12 +9,12 @@ Web search preview tool configuration (2025-03-11 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `max_results` | *Optional[int]* | ➖ | 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 | -| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | -| `type` | [components.Preview20250311WebSearchServerToolType](../components/preview20250311websearchservertooltype.mdx) | ✅ | N/A | | -| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `max_results` | *Optional[int]* | :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 | +| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `type` | [components.Preview20250311WebSearchServerToolType](../components/preview20250311websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | +| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/previewwebsearchservertool.mdx b/docs/components/previewwebsearchservertool.mdx index 6f6212a0b..ccbdb6a61 100644 --- a/docs/components/previewwebsearchservertool.mdx +++ b/docs/components/previewwebsearchservertool.mdx @@ -9,12 +9,12 @@ Web search preview tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `max_results` | *Optional[int]* | ➖ | 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 | -| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | -| `type` | [components.PreviewWebSearchServerToolType](../components/previewwebsearchservertooltype.mdx) | ✅ | N/A | | -| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `max_results` | *Optional[int]* | :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 | +| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `type` | [components.PreviewWebSearchServerToolType](../components/previewwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | +| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/previewwebsearchuserlocation.mdx b/docs/components/previewwebsearchuserlocation.mdx index e95372301..1695e4049 100644 --- a/docs/components/previewwebsearchuserlocation.mdx +++ b/docs/components/previewwebsearchuserlocation.mdx @@ -6,8 +6,8 @@ title: "PreviewWebSearchUserLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `city` | *OptionalNullable[str]* | ➖ | N/A | -| `country` | *OptionalNullable[str]* | ➖ | N/A | -| `region` | *OptionalNullable[str]* | ➖ | N/A | -| `timezone` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.PreviewWebSearchUserLocationType](../components/previewwebsearchuserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.PreviewWebSearchUserLocationType](../components/previewwebsearchuserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/pricing.mdx b/docs/components/pricing.mdx index cc6ad3ed9..e60ec6cfd 100644 --- a/docs/components/pricing.mdx +++ b/docs/components/pricing.mdx @@ -6,19 +6,19 @@ title: "Pricing" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `audio` | *Optional[str]* | ➖ | Price in USD per audio input token | -| `audio_output` | *Optional[str]* | ➖ | Price in USD per audio output token | -| `completion` | *str* | ✅ | Price in USD per token for completion (output) generation | -| `discount` | *Optional[float]* | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `image` | *Optional[str]* | ➖ | Price in USD per input image | -| `image_output` | *Optional[str]* | ➖ | Price in USD per output image | -| `image_token` | *Optional[str]* | ➖ | Price in USD per image token | -| `input_audio_cache` | *Optional[str]* | ➖ | Price in USD per cached audio input token | -| `input_cache_read` | *Optional[str]* | ➖ | Price in USD per cached input token (read) | -| `input_cache_write` | *Optional[str]* | ➖ | 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. | -| `input_cache_write_1h` | *Optional[str]* | ➖ | 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. | -| `internal_reasoning` | *Optional[str]* | ➖ | Price in USD per internal reasoning token | -| `overrides` | List[[components.PricingOverride](../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` | *str* | ✅ | Price in USD per token for prompt (input) processing | -| `request` | *Optional[str]* | ➖ | Price in USD per request | -| `web_search` | *Optional[str]* | ➖ | Price in USD per web search | \ No newline at end of file +| `audio` | *Optional[str]* | :heavy_minus_sign: | Price in USD per audio input token | +| `audio_output` | *Optional[str]* | :heavy_minus_sign: | Price in USD per audio output token | +| `completion` | *str* | :heavy_check_mark: | Price in USD per token for completion (output) generation | +| `discount` | *Optional[float]* | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `image` | *Optional[str]* | :heavy_minus_sign: | Price in USD per input image | +| `image_output` | *Optional[str]* | :heavy_minus_sign: | Price in USD per output image | +| `image_token` | *Optional[str]* | :heavy_minus_sign: | Price in USD per image token | +| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | Price in USD per cached audio input token | +| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | Price in USD per cached input token (read) | +| `input_cache_write` | *Optional[str]* | :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. | +| `input_cache_write_1h` | *Optional[str]* | :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. | +| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | Price in USD per internal reasoning token | +| `overrides` | List[[components.PricingOverride](../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` | *str* | :heavy_check_mark: | Price in USD per token for prompt (input) processing | +| `request` | *Optional[str]* | :heavy_minus_sign: | Price in USD per request | +| `web_search` | *Optional[str]* | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file diff --git a/docs/components/pricingoverride.mdx b/docs/components/pricingoverride.mdx index a233ad3c5..b7d539e20 100644 --- a/docs/components/pricingoverride.mdx +++ b/docs/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` | *Optional[str]* | ➖ | Overridden price in USD per audio input token | -| `completion` | *Optional[str]* | ➖ | Overridden price in USD per token for completion (output) generation | -| `input_audio_cache` | *Optional[str]* | ➖ | Overridden price in USD per cached audio input token | -| `input_cache_read` | *Optional[str]* | ➖ | Overridden price in USD per cached input token (read) | -| `input_cache_write` | *Optional[str]* | ➖ | Overridden price in USD per cache-write token | -| `input_cache_write_1h` | *Optional[str]* | ➖ | Overridden price in USD per 1-hour cache-write token | -| `min_prompt_tokens` | *Optional[float]* | ➖ | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | -| `prompt` | *Optional[str]* | ➖ | Overridden price in USD per token for prompt (input) processing | -| `utc_days` | List[[components.UtcDay](../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. | -| `utc_end` | *Optional[float]* | ➖ | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | -| `utc_start` | *Optional[float]* | ➖ | 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` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per audio input token | +| `completion` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per token for completion (output) generation | +| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per cached audio input token | +| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per cached input token (read) | +| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per cache-write token | +| `input_cache_write_1h` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per 1-hour cache-write token | +| `min_prompt_tokens` | *Optional[float]* | :heavy_minus_sign: | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | +| `prompt` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per token for prompt (input) processing | +| `utc_days` | List[[components.UtcDay](../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. | +| `utc_end` | *Optional[float]* | :heavy_minus_sign: | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | +| `utc_start` | *Optional[float]* | :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/components/privateendpoint.mdx b/docs/components/privateendpoint.mdx index 926be8291..89ec31591 100644 --- a/docs/components/privateendpoint.mdx +++ b/docs/components/privateendpoint.mdx @@ -6,15 +6,15 @@ title: "PrivateEndpoint" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `base_url` | *Nullable[str]* | ✅ | 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 | -| `declared_region` | [Nullable[components.PrivateEndpointDeclaredRegion]](../components/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `declared_zdr` | *Nullable[bool]* | ✅ | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `model_name` | *Nullable[str]* | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `model_slug` | *Nullable[str]* | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `pricing` | [components.PrivateEndpointPricing](../components/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `provider_name` | *str* | ✅ | Display name of the upstream provider. | Azure | -| `provider_slug` | *Nullable[str]* | ✅ | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | -| `status` | [components.PrivateEndpointStatus](../components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | -| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `base_url` | *Nullable[str]* | :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 | +| `declared_region` | [Nullable[components.PrivateEndpointDeclaredRegion]](../components/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `declared_zdr` | *Nullable[bool]* | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `model_name` | *Nullable[str]* | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `model_slug` | *Nullable[str]* | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `pricing` | [components.PrivateEndpointPricing](../components/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `provider_name` | *str* | :heavy_check_mark: | Display name of the upstream provider. | Azure | +| `provider_slug` | *Nullable[str]* | :heavy_check_mark: | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | +| `status` | [components.PrivateEndpointStatus](../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 | +| `upstream_model_id` | *str* | :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/components/privateendpointactivation.mdx b/docs/components/privateendpointactivation.mdx index 724baa31c..22af2c3b4 100644 --- a/docs/components/privateendpointactivation.mdx +++ b/docs/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 | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `workspace_id` | *str* | ✅ | 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 +| `workspace_id` | *str* | :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/components/privateendpointcheck.mdx b/docs/components/privateendpointcheck.mdx index 1648e5555..2131ef57c 100644 --- a/docs/components/privateendpointcheck.mdx +++ b/docs/components/privateendpointcheck.mdx @@ -6,9 +6,9 @@ title: "PrivateEndpointCheck" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `actual_model` | *OptionalNullable[str]* | ➖ | Model the upstream reported serving, when it differs from the request. | | -| `name` | *str* | ✅ | Check name. | auth_ok | -| `passed` | *bool* | ✅ | N/A | | -| `reason` | [Optional[components.PrivateEndpointCheckReason]](../components/privateendpointcheckreason.mdx) | ➖ | Why the check failed. | no_byok_key | -| `upstream_message` | *OptionalNullable[str]* | ➖ | Error message returned by your deployment when the call failed. | | -| `upstream_status` | *Optional[int]* | ➖ | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file +| `actual_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Model the upstream reported serving, when it differs from the request. | | +| `name` | *str* | :heavy_check_mark: | Check name. | auth_ok | +| `passed` | *bool* | :heavy_check_mark: | N/A | | +| `reason` | [Optional[components.PrivateEndpointCheckReason]](../components/privateendpointcheckreason.mdx) | :heavy_minus_sign: | Why the check failed. | no_byok_key | +| `upstream_message` | *OptionalNullable[str]* | :heavy_minus_sign: | Error message returned by your deployment when the call failed. | | +| `upstream_status` | *Optional[int]* | :heavy_minus_sign: | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file diff --git a/docs/components/privateendpointpricing.mdx b/docs/components/privateendpointpricing.mdx index 479c40072..15a8329bc 100644 --- a/docs/components/privateendpointpricing.mdx +++ b/docs/components/privateendpointpricing.mdx @@ -9,5 +9,5 @@ Negotiated per-token rates reported for requests routed to this endpoint. | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `completion` | *str* | ✅ | USD per completion token, as a decimal string. | 0.00001 | -| `prompt` | *str* | ✅ | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file +| `completion` | *str* | :heavy_check_mark: | USD per completion token, as a decimal string. | 0.00001 | +| `prompt` | *str* | :heavy_check_mark: | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file diff --git a/docs/components/privateendpointresponse.mdx b/docs/components/privateendpointresponse.mdx index f40498bbd..ebc7588e0 100644 --- a/docs/components/privateendpointresponse.mdx +++ b/docs/components/privateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "PrivateEndpointResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.PrivateEndpoint](../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](../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/components/privateendpointsummary.mdx b/docs/components/privateendpointsummary.mdx index 7baf7c994..d88a936da 100644 --- a/docs/components/privateendpointsummary.mdx +++ b/docs/components/privateendpointsummary.mdx @@ -6,10 +6,10 @@ title: "PrivateEndpointSummary" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `model_name` | *Nullable[str]* | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `model_slug` | *Nullable[str]* | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `provider_name` | *str* | ✅ | Display name of the upstream provider. | Azure | -| `status` | [components.PrivateEndpointStatus](../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 +| `created_at` | *str* | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `model_name` | *Nullable[str]* | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `model_slug` | *Nullable[str]* | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `provider_name` | *str* | :heavy_check_mark: | Display name of the upstream provider. | Azure | +| `status` | [components.PrivateEndpointStatus](../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/components/privateendpointvalidation.mdx b/docs/components/privateendpointvalidation.mdx index e0037589a..dd31ec90b 100644 --- a/docs/components/privateendpointvalidation.mdx +++ b/docs/components/privateendpointvalidation.mdx @@ -6,5 +6,5 @@ title: "PrivateEndpointValidation" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `checks` | List[[components.PrivateEndpointCheck](../components/privateendpointcheck.mdx)] | ✅ | N/A | | -| `passed` | *bool* | ✅ | Whether every check passed. | true | \ No newline at end of file +| `checks` | List[[components.PrivateEndpointCheck](../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/components/privateendpointvalidationnullable.mdx b/docs/components/privateendpointvalidationnullable.mdx index b677c603b..a7e2dfdc1 100644 --- a/docs/components/privateendpointvalidationnullable.mdx +++ b/docs/components/privateendpointvalidationnullable.mdx @@ -6,5 +6,5 @@ title: "PrivateEndpointValidationNullable" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `checks` | List[[components.PrivateEndpointCheck](../components/privateendpointcheck.mdx)] | ✅ | N/A | | -| `passed` | *bool* | ✅ | Whether every check passed. | true | \ No newline at end of file +| `checks` | List[[components.PrivateEndpointCheck](../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/components/privateendpointvalidationresponse.mdx b/docs/components/privateendpointvalidationresponse.mdx index d72ba5c13..97db30857 100644 --- a/docs/components/privateendpointvalidationresponse.mdx +++ b/docs/components/privateendpointvalidationresponse.mdx @@ -6,4 +6,4 @@ title: "PrivateEndpointValidationResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `data` | [components.PrivateEndpointValidation](../components/privateendpointvalidation.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.PrivateEndpointValidation](../components/privateendpointvalidation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/progress.mdx b/docs/components/progress.mdx index bf32f73ec..1c5f4b732 100644 --- a/docs/components/progress.mdx +++ b/docs/components/progress.mdx @@ -9,6 +9,6 @@ Active provisioning step, or null once provisioning has settled. | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `step_label` | *str* | ✅ | Human-readable label of the active provisioning step. | -| `step_number` | *int* | ✅ | One-based index of the active step. | -| `total_steps` | *int* | ✅ | Number of provisioning steps. | \ No newline at end of file +| `step_label` | *str* | :heavy_check_mark: | Human-readable label of the active provisioning step. | +| `step_number` | *int* | :heavy_check_mark: | One-based index of the active step. | +| `total_steps` | *int* | :heavy_check_mark: | Number of provisioning steps. | \ No newline at end of file diff --git a/docs/components/promptcachebreakpoint.mdx b/docs/components/promptcachebreakpoint.mdx index d05c026de..313ab84d0 100644 --- a/docs/components/promptcachebreakpoint.mdx +++ b/docs/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](../components/promptcachebreakpointmode.mdx) | ✅ | N/A | \ No newline at end of file +| `mode` | [components.PromptCacheBreakpointMode](../components/promptcachebreakpointmode.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/promptcacheoptions.mdx b/docs/components/promptcacheoptions.mdx index 4d05fd3b0..a9b20d3f9 100644 --- a/docs/components/promptcacheoptions.mdx +++ b/docs/components/promptcacheoptions.mdx @@ -9,5 +9,5 @@ Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `mode` | [components.PromptCacheOptionsMode](../components/promptcacheoptionsmode.mdx) | ✅ | N/A | -| `ttl` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file +| `mode` | [components.PromptCacheOptionsMode](../components/promptcacheoptionsmode.mdx) | :heavy_check_mark: | N/A | +| `ttl` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/provideroptions.mdx b/docs/components/provideroptions.mdx index 72536c549..cb5a52ce9 100644 --- a/docs/components/provideroptions.mdx +++ b/docs/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` | Dict[str, *Any*] | ➖ | N/A | -| `ai21` | Dict[str, *Any*] | ➖ | N/A | -| `aion_labs` | Dict[str, *Any*] | ➖ | N/A | -| `akashml` | Dict[str, *Any*] | ➖ | N/A | -| `alibaba` | Dict[str, *Any*] | ➖ | N/A | -| `amazon_bedrock` | Dict[str, *Any*] | ➖ | N/A | -| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | -| `amazon_nova` | Dict[str, *Any*] | ➖ | N/A | -| `ambient` | Dict[str, *Any*] | ➖ | N/A | -| `anthropic` | Dict[str, *Any*] | ➖ | N/A | -| `anthropic_2` | Dict[str, *Any*] | ➖ | N/A | -| `anyscale` | Dict[str, *Any*] | ➖ | N/A | -| `arcee_ai` | Dict[str, *Any*] | ➖ | N/A | -| `assemblyai` | Dict[str, *Any*] | ➖ | N/A | -| `atlas_cloud` | Dict[str, *Any*] | ➖ | N/A | -| `atoma` | Dict[str, *Any*] | ➖ | N/A | -| `avian` | Dict[str, *Any*] | ➖ | N/A | -| `azure` | Dict[str, *Any*] | ➖ | N/A | -| `baidu` | Dict[str, *Any*] | ➖ | N/A | -| `baseten` | Dict[str, *Any*] | ➖ | N/A | -| `black_forest_labs` | Dict[str, *Any*] | ➖ | N/A | -| `byteplus` | Dict[str, *Any*] | ➖ | N/A | -| `centml` | Dict[str, *Any*] | ➖ | N/A | -| `cerebras` | Dict[str, *Any*] | ➖ | N/A | -| `chutes` | Dict[str, *Any*] | ➖ | N/A | -| `cirrascale` | Dict[str, *Any*] | ➖ | N/A | -| `clarifai` | Dict[str, *Any*] | ➖ | N/A | -| `claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | -| `cloudflare` | Dict[str, *Any*] | ➖ | N/A | -| `cohere` | Dict[str, *Any*] | ➖ | N/A | -| `coreweave` | Dict[str, *Any*] | ➖ | N/A | -| `cosine` | Dict[str, *Any*] | ➖ | N/A | -| `crofai` | Dict[str, *Any*] | ➖ | N/A | -| `crucible` | Dict[str, *Any*] | ➖ | N/A | -| `crusoe` | Dict[str, *Any*] | ➖ | N/A | -| `darkbloom` | Dict[str, *Any*] | ➖ | N/A | -| `databricks` | Dict[str, *Any*] | ➖ | N/A | -| `decart` | Dict[str, *Any*] | ➖ | N/A | -| `deepgram` | Dict[str, *Any*] | ➖ | N/A | -| `deepinfra` | Dict[str, *Any*] | ➖ | N/A | -| `deepseek` | Dict[str, *Any*] | ➖ | N/A | -| `dekallm` | Dict[str, *Any*] | ➖ | N/A | -| `digitalocean` | Dict[str, *Any*] | ➖ | N/A | -| `elevenlabs` | Dict[str, *Any*] | ➖ | N/A | -| `enfer` | Dict[str, *Any*] | ➖ | N/A | -| `fake_provider` | Dict[str, *Any*] | ➖ | N/A | -| `featherless` | Dict[str, *Any*] | ➖ | N/A | -| `fireworks` | Dict[str, *Any*] | ➖ | N/A | -| `fish_audio` | Dict[str, *Any*] | ➖ | N/A | -| `friendli` | Dict[str, *Any*] | ➖ | N/A | -| `gmicloud` | Dict[str, *Any*] | ➖ | N/A | -| `google_ai_studio` | Dict[str, *Any*] | ➖ | N/A | -| `google_vertex` | Dict[str, *Any*] | ➖ | N/A | -| `gopomelo` | Dict[str, *Any*] | ➖ | N/A | -| `groq` | Dict[str, *Any*] | ➖ | N/A | -| `heygen` | Dict[str, *Any*] | ➖ | N/A | -| `huggingface` | Dict[str, *Any*] | ➖ | N/A | -| `hyperbolic` | Dict[str, *Any*] | ➖ | N/A | -| `hyperbolic_quantized` | Dict[str, *Any*] | ➖ | N/A | -| `inception` | Dict[str, *Any*] | ➖ | N/A | -| `inceptron` | Dict[str, *Any*] | ➖ | N/A | -| `inferact_vllm` | Dict[str, *Any*] | ➖ | N/A | -| `inference_net` | Dict[str, *Any*] | ➖ | N/A | -| `infermatic` | Dict[str, *Any*] | ➖ | N/A | -| `inflection` | Dict[str, *Any*] | ➖ | N/A | -| `inocloud` | Dict[str, *Any*] | ➖ | N/A | -| `io_net` | Dict[str, *Any*] | ➖ | N/A | -| `ionstream` | Dict[str, *Any*] | ➖ | N/A | -| `klusterai` | Dict[str, *Any*] | ➖ | N/A | -| `krea` | Dict[str, *Any*] | ➖ | N/A | -| `lambda_` | Dict[str, *Any*] | ➖ | N/A | -| `lepton` | Dict[str, *Any*] | ➖ | N/A | -| `liquid` | Dict[str, *Any*] | ➖ | N/A | -| `lynn` | Dict[str, *Any*] | ➖ | N/A | -| `lynn_private` | Dict[str, *Any*] | ➖ | N/A | -| `makora` | Dict[str, *Any*] | ➖ | N/A | -| `mancer` | Dict[str, *Any*] | ➖ | N/A | -| `mancer_old` | Dict[str, *Any*] | ➖ | N/A | -| `mara` | Dict[str, *Any*] | ➖ | N/A | -| `meta` | Dict[str, *Any*] | ➖ | N/A | -| `minimax` | Dict[str, *Any*] | ➖ | N/A | -| `mistral` | Dict[str, *Any*] | ➖ | N/A | -| `modal` | Dict[str, *Any*] | ➖ | N/A | -| `modelrun` | Dict[str, *Any*] | ➖ | N/A | -| `modular` | Dict[str, *Any*] | ➖ | N/A | -| `moonshotai` | Dict[str, *Any*] | ➖ | N/A | -| `morph` | Dict[str, *Any*] | ➖ | N/A | -| `ncompass` | Dict[str, *Any*] | ➖ | N/A | -| `near_ai` | Dict[str, *Any*] | ➖ | N/A | -| `nebius` | Dict[str, *Any*] | ➖ | N/A | -| `nex_agi` | Dict[str, *Any*] | ➖ | N/A | -| `nextbit` | Dict[str, *Any*] | ➖ | N/A | -| `nineteen` | Dict[str, *Any*] | ➖ | N/A | -| `novita` | Dict[str, *Any*] | ➖ | N/A | -| `nvidia` | Dict[str, *Any*] | ➖ | N/A | -| `octoai` | Dict[str, *Any*] | ➖ | N/A | -| `ollama` | Dict[str, *Any*] | ➖ | N/A | -| `open_inference` | Dict[str, *Any*] | ➖ | N/A | -| `openai` | Dict[str, *Any*] | ➖ | N/A | -| `parasail` | Dict[str, *Any*] | ➖ | N/A | -| `perceptron` | Dict[str, *Any*] | ➖ | N/A | -| `perplexity` | Dict[str, *Any*] | ➖ | N/A | -| `phala` | Dict[str, *Any*] | ➖ | N/A | -| `poolside` | Dict[str, *Any*] | ➖ | N/A | -| `primeintellect` | Dict[str, *Any*] | ➖ | N/A | -| `quiver` | Dict[str, *Any*] | ➖ | N/A | -| `recraft` | Dict[str, *Any*] | ➖ | N/A | -| `recursal` | Dict[str, *Any*] | ➖ | N/A | -| `reflection` | Dict[str, *Any*] | ➖ | N/A | -| `reka` | Dict[str, *Any*] | ➖ | N/A | -| `relace` | Dict[str, *Any*] | ➖ | N/A | -| `replicate` | Dict[str, *Any*] | ➖ | N/A | -| `respan` | Dict[str, *Any*] | ➖ | N/A | -| `runway` | Dict[str, *Any*] | ➖ | N/A | -| `sail_research` | Dict[str, *Any*] | ➖ | N/A | -| `sakana` | Dict[str, *Any*] | ➖ | N/A | -| `sakana_ai` | Dict[str, *Any*] | ➖ | N/A | -| `sambanova` | Dict[str, *Any*] | ➖ | N/A | -| `sambanova_cloaked` | Dict[str, *Any*] | ➖ | N/A | -| `scaledown` | Dict[str, *Any*] | ➖ | N/A | -| `seed` | Dict[str, *Any*] | ➖ | N/A | -| `sf_compute` | Dict[str, *Any*] | ➖ | N/A | -| `siliconflow` | Dict[str, *Any*] | ➖ | N/A | -| `sourceful` | Dict[str, *Any*] | ➖ | N/A | -| `stealth` | Dict[str, *Any*] | ➖ | N/A | -| `stepfun` | Dict[str, *Any*] | ➖ | N/A | -| `streamlake` | Dict[str, *Any*] | ➖ | N/A | -| `switchpoint` | Dict[str, *Any*] | ➖ | N/A | -| `targon` | Dict[str, *Any*] | ➖ | N/A | -| `tencent` | Dict[str, *Any*] | ➖ | N/A | -| `tenstorrent` | Dict[str, *Any*] | ➖ | N/A | -| `thinkingmachines` | Dict[str, *Any*] | ➖ | N/A | -| `together` | Dict[str, *Any*] | ➖ | N/A | -| `together_lite` | Dict[str, *Any*] | ➖ | N/A | -| `typesafe` | Dict[str, *Any*] | ➖ | N/A | -| `ubicloud` | Dict[str, *Any*] | ➖ | N/A | -| `unbiased` | Dict[str, *Any*] | ➖ | N/A | -| `upstage` | Dict[str, *Any*] | ➖ | N/A | -| `venice` | Dict[str, *Any*] | ➖ | N/A | -| `voyageai` | Dict[str, *Any*] | ➖ | N/A | -| `wafer` | Dict[str, *Any*] | ➖ | N/A | -| `wandb` | Dict[str, *Any*] | ➖ | N/A | -| `wandb_legacy` | Dict[str, *Any*] | ➖ | N/A | -| `xai` | Dict[str, *Any*] | ➖ | N/A | -| `xiaomi` | Dict[str, *Any*] | ➖ | N/A | -| `z_ai` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `oneai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ai21` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `aion_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `akashml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `alibaba` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `amazon_bedrock` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `amazon_nova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ambient` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `anthropic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `anthropic_2` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `anyscale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `arcee_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `assemblyai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `atlas_cloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `atoma` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `avian` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `azure` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `baidu` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `baseten` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `black_forest_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `byteplus` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `centml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cerebras` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `chutes` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cirrascale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `clarifai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cloudflare` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cohere` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `coreweave` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cosine` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `crofai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `crucible` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `crusoe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `darkbloom` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `databricks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `decart` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deepgram` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deepinfra` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deepseek` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `dekallm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `digitalocean` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `elevenlabs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `enfer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fake_provider` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `featherless` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fireworks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fish_audio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `friendli` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `gmicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `google_ai_studio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `google_vertex` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `gopomelo` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `groq` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `heygen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `huggingface` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `hyperbolic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `hyperbolic_quantized` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inception` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inferact_vllm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inference_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `infermatic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inocloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `io_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ionstream` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `klusterai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `krea` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lambda_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lepton` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `liquid` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lynn` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lynn_private` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `makora` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mancer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mancer_old` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mara` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `meta` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `minimax` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mistral` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `modal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `modelrun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `modular` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `moonshotai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `morph` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ncompass` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `near_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nebius` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nex_agi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nextbit` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nineteen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `novita` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nvidia` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `octoai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ollama` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `open_inference` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `openai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `parasail` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `perceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `perplexity` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `phala` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `poolside` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `primeintellect` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `quiver` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `recraft` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `recursal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `reflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `reka` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `relace` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `replicate` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `respan` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `runway` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sail_research` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sakana` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sakana_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sambanova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sambanova_cloaked` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `scaledown` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `seed` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sf_compute` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `siliconflow` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sourceful` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `stealth` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `stepfun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `streamlake` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `switchpoint` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `targon` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `tencent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `tenstorrent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `thinkingmachines` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `together` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `together_lite` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `typesafe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ubicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `unbiased` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `upstage` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `venice` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `voyageai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `wafer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `wandb` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `wandb_legacy` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `xai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `xiaomi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `z_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/provideroverloadedresponseerrordata.mdx b/docs/components/provideroverloadedresponseerrordata.mdx index 26f853326..8318f5211 100644 --- a/docs/components/provideroverloadedresponseerrordata.mdx +++ b/docs/components/provideroverloadedresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ProviderOverloadedResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/providerpreferences.mdx b/docs/components/providerpreferences.mdx index db7cd85be..2ae5e4b4a 100644 --- a/docs/components/providerpreferences.mdx +++ b/docs/components/providerpreferences.mdx @@ -9,17 +9,17 @@ Provider routing preferences for the request. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allow_fallbacks` | *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.
| | -| `data_collection` | [OptionalNullable[components.DataCollection]](../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 | -| `enforce_distillable_text` | *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` | List[[components.ProviderPreferencesIgnore](../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"
] | -| `max_price` | [Optional[components.MaxPrice]](../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` | List[[components.ProviderPreferencesOnly](../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` | [Optional[components.ProviderOptions]](../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` | List[[components.ProviderPreferencesOrder](../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"
] | -| `preferred_max_latency` | [OptionalNullable[components.PreferredMaxLatency]](../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 | -| `preferred_min_throughput` | [OptionalNullable[components.PreferredMinThroughput]](../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` | List[[components.Quantization](../components/quantization.mdx)] | ➖ | A list of quantization levels to filter the provider by. | | -| `require_parameters` | *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[components.ProviderPreferencesSort]](../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[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 +| `allow_fallbacks` | *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.
| | +| `data_collection` | [OptionalNullable[components.DataCollection]](../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 | +| `enforce_distillable_text` | *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` | List[[components.ProviderPreferencesIgnore](../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"
] | +| `max_price` | [Optional[components.MaxPrice]](../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` | List[[components.ProviderPreferencesOnly](../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` | [Optional[components.ProviderOptions]](../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` | List[[components.ProviderPreferencesOrder](../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"
] | +| `preferred_max_latency` | [OptionalNullable[components.PreferredMaxLatency]](../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 | +| `preferred_min_throughput` | [OptionalNullable[components.PreferredMinThroughput]](../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` | List[[components.Quantization](../components/quantization.mdx)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | +| `require_parameters` | *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[components.ProviderPreferencesSort]](../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[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/components/providerresponse.mdx b/docs/components/providerresponse.mdx index 526b30036..dd376f095 100644 --- a/docs/components/providerresponse.mdx +++ b/docs/components/providerresponse.mdx @@ -9,11 +9,11 @@ Details of a provider response for a generation attempt | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `endpoint_id` | *Optional[str]* | ➖ | Internal endpoint identifier | ep_abc123 | -| `id` | *Optional[str]* | ➖ | Upstream provider response identifier | chatcmpl-abc123 | -| `is_byok` | *Optional[bool]* | ➖ | Whether the request used a bring-your-own-key | false | -| `latency` | *Optional[float]* | ➖ | Response latency in milliseconds | 1200 | -| `model_permaslug` | *Optional[str]* | ➖ | Canonical model slug | openai/gpt-4 | -| `provider_name` | [Optional[components.ProviderResponseProviderName]](../components/providerresponseprovidername.mdx) | ➖ | Name of the provider | OpenAI | -| `routed_service_tier` | [Optional[components.RoutedServiceTier]](../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` | *Nullable[int]* | ✅ | HTTP status code from the provider | 200 | \ No newline at end of file +| `endpoint_id` | *Optional[str]* | :heavy_minus_sign: | Internal endpoint identifier | ep_abc123 | +| `id` | *Optional[str]* | :heavy_minus_sign: | Upstream provider response identifier | chatcmpl-abc123 | +| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether the request used a bring-your-own-key | false | +| `latency` | *Optional[float]* | :heavy_minus_sign: | Response latency in milliseconds | 1200 | +| `model_permaslug` | *Optional[str]* | :heavy_minus_sign: | Canonical model slug | openai/gpt-4 | +| `provider_name` | [Optional[components.ProviderResponseProviderName]](../components/providerresponseprovidername.mdx) | :heavy_minus_sign: | Name of the provider | OpenAI | +| `routed_service_tier` | [Optional[components.RoutedServiceTier]](../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` | *Nullable[int]* | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/docs/components/providersortconfig.mdx b/docs/components/providersortconfig.mdx index d9306e318..5aa8e90a6 100644 --- a/docs/components/providersortconfig.mdx +++ b/docs/components/providersortconfig.mdx @@ -9,5 +9,5 @@ The provider sorting strategy (price, throughput, latency) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `by` | [OptionalNullable[components.By]](../components/by.mdx) | ➖ | The provider sorting strategy (price, throughput, latency) | price | -| `partition` | [OptionalNullable[components.Partition]](../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[components.By]](../components/by.mdx) | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | +| `partition` | [OptionalNullable[components.Partition]](../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/components/provisioninternresponse.mdx b/docs/components/provisioninternresponse.mdx index 18f80f088..be1e5af93 100644 --- a/docs/components/provisioninternresponse.mdx +++ b/docs/components/provisioninternresponse.mdx @@ -6,4 +6,4 @@ title: "ProvisionInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `provisioning` | *Literal[True]* | ✅ | N/A | \ No newline at end of file +| `provisioning` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/publicendpoint.mdx b/docs/components/publicendpoint.mdx index 3a1c6da93..f4828c024 100644 --- a/docs/components/publicendpoint.mdx +++ b/docs/components/publicendpoint.mdx @@ -9,27 +9,27 @@ Information about a specific model endpoint | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context_length` | *int* | ✅ | N/A | | -| `latency_last_30m` | [Nullable[components.PercentileStats]](../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
} | -| `max_completion_tokens` | *Nullable[int]* | ✅ | 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. | | -| `max_prompt_tokens` | *Nullable[int]* | ✅ | N/A | | -| `model_id` | *str* | ✅ | The unique identifier for the model (permaslug) | openai/gpt-4 | -| `model_name` | *str* | ✅ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `native_tools` | Dict[str, [components.NativeTools](../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"
}
} | -| `perf_last_30m_by_workload` | [Optional[components.PerfLast30mByWorkload]](../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](../components/pricing.mdx) | ✅ | N/A | | -| `provider_name` | [components.ProviderName](../components/providername.mdx) | ✅ | N/A | OpenAI | -| `quantization` | [Nullable[components.Quantization]](../components/quantization.mdx) | ✅ | N/A | fp16 | -| `status` | [Optional[components.EndpointStatus]](../components/endpointstatus.mdx) | ➖ | N/A | 0 | -| `supported_parameters` | List[[components.Parameter](../components/parameter.mdx)] | ✅ | N/A | | -| `supports_image_reference` | *Optional[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. | | -| `supports_implicit_caching` | *bool* | ✅ | N/A | | -| `supports_multiple_audio_references` | *Optional[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. | | -| `supports_tool_choice` | [components.ToolChoiceSupport](../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
} | -| `supports_voice_cloning` | *Optional[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` | *str* | ✅ | N/A | | -| `throughput_last_30m` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `uptime_last_1d` | *Nullable[float]* | ✅ | 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. | | -| `uptime_last_30m` | *Nullable[float]* | ✅ | N/A | | -| `uptime_last_5m` | *Nullable[float]* | ✅ | 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 +| `context_length` | *int* | :heavy_check_mark: | N/A | | +| `latency_last_30m` | [Nullable[components.PercentileStats]](../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
} | +| `max_completion_tokens` | *Nullable[int]* | :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. | | +| `max_prompt_tokens` | *Nullable[int]* | :heavy_check_mark: | N/A | | +| `model_id` | *str* | :heavy_check_mark: | The unique identifier for the model (permaslug) | openai/gpt-4 | +| `model_name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `native_tools` | Dict[str, [components.NativeTools](../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"
}
} | +| `perf_last_30m_by_workload` | [Optional[components.PerfLast30mByWorkload]](../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](../components/pricing.mdx) | :heavy_check_mark: | N/A | | +| `provider_name` | [components.ProviderName](../components/providername.mdx) | :heavy_check_mark: | N/A | OpenAI | +| `quantization` | [Nullable[components.Quantization]](../components/quantization.mdx) | :heavy_check_mark: | N/A | fp16 | +| `status` | [Optional[components.EndpointStatus]](../components/endpointstatus.mdx) | :heavy_minus_sign: | N/A | 0 | +| `supported_parameters` | List[[components.Parameter](../components/parameter.mdx)] | :heavy_check_mark: | N/A | | +| `supports_image_reference` | *Optional[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. | | +| `supports_implicit_caching` | *bool* | :heavy_check_mark: | N/A | | +| `supports_multiple_audio_references` | *Optional[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. | | +| `supports_tool_choice` | [components.ToolChoiceSupport](../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
} | +| `supports_voice_cloning` | *Optional[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` | *str* | :heavy_check_mark: | N/A | | +| `throughput_last_30m` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `uptime_last_1d` | *Nullable[float]* | :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. | | +| `uptime_last_30m` | *Nullable[float]* | :heavy_check_mark: | N/A | | +| `uptime_last_5m` | *Nullable[float]* | :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/components/publicpricing.mdx b/docs/components/publicpricing.mdx index 36b7ef583..894ca95c0 100644 --- a/docs/components/publicpricing.mdx +++ b/docs/components/publicpricing.mdx @@ -9,19 +9,19 @@ Pricing information for the model | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `audio` | *Optional[str]* | ➖ | Price in USD per audio input token | -| `audio_output` | *Optional[str]* | ➖ | Price in USD per audio output token | -| `completion` | *str* | ✅ | Price in USD per token for completion (output) generation | -| `discount` | *Optional[float]* | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `image` | *Optional[str]* | ➖ | Price in USD per input image | -| `image_output` | *Optional[str]* | ➖ | Price in USD per output image | -| `image_token` | *Optional[str]* | ➖ | Price in USD per image token | -| `input_audio_cache` | *Optional[str]* | ➖ | Price in USD per cached audio input token | -| `input_cache_read` | *Optional[str]* | ➖ | Price in USD per cached input token (read) | -| `input_cache_write` | *Optional[str]* | ➖ | 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. | -| `input_cache_write_1h` | *Optional[str]* | ➖ | 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. | -| `internal_reasoning` | *Optional[str]* | ➖ | Price in USD per internal reasoning token | -| `overrides` | List[[components.PricingOverride](../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` | *str* | ✅ | Price in USD per token for prompt (input) processing | -| `request` | *Optional[str]* | ➖ | Price in USD per request | -| `web_search` | *Optional[str]* | ➖ | Price in USD per web search | \ No newline at end of file +| `audio` | *Optional[str]* | :heavy_minus_sign: | Price in USD per audio input token | +| `audio_output` | *Optional[str]* | :heavy_minus_sign: | Price in USD per audio output token | +| `completion` | *str* | :heavy_check_mark: | Price in USD per token for completion (output) generation | +| `discount` | *Optional[float]* | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `image` | *Optional[str]* | :heavy_minus_sign: | Price in USD per input image | +| `image_output` | *Optional[str]* | :heavy_minus_sign: | Price in USD per output image | +| `image_token` | *Optional[str]* | :heavy_minus_sign: | Price in USD per image token | +| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | Price in USD per cached audio input token | +| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | Price in USD per cached input token (read) | +| `input_cache_write` | *Optional[str]* | :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. | +| `input_cache_write_1h` | *Optional[str]* | :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. | +| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | Price in USD per internal reasoning token | +| `overrides` | List[[components.PricingOverride](../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` | *str* | :heavy_check_mark: | Price in USD per token for prompt (input) processing | +| `request` | *Optional[str]* | :heavy_minus_sign: | Price in USD per request | +| `web_search` | *Optional[str]* | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file diff --git a/docs/components/rangecapability.mdx b/docs/components/rangecapability.mdx index a5ab7c9b6..34425c50e 100644 --- a/docs/components/rangecapability.mdx +++ b/docs/components/rangecapability.mdx @@ -9,6 +9,6 @@ A parameter that accepts any value within an inclusive numeric range. | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `max` | *float* | ✅ | N/A | -| `min` | *float* | ✅ | N/A | -| `type` | [components.RangeCapabilityType](../components/rangecapabilitytype.mdx) | ✅ | N/A | \ No newline at end of file +| `max` | *float* | :heavy_check_mark: | N/A | +| `min` | *float* | :heavy_check_mark: | N/A | +| `type` | [components.RangeCapabilityType](../components/rangecapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/rankingoptions.mdx b/docs/components/rankingoptions.mdx index 1f2d64ea6..2f3d38a04 100644 --- a/docs/components/rankingoptions.mdx +++ b/docs/components/rankingoptions.mdx @@ -6,5 +6,5 @@ title: "RankingOptions" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `ranker` | [Optional[components.Ranker]](../components/ranker.mdx) | ➖ | N/A | -| `score_threshold` | *Optional[float]* | ➖ | N/A | \ No newline at end of file +| `ranker` | [Optional[components.Ranker]](../components/ranker.mdx) | :heavy_minus_sign: | N/A | +| `score_threshold` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/rankingsdailyitem.mdx b/docs/components/rankingsdailyitem.mdx index 370e0f663..b2e760295 100644 --- a/docs/components/rankingsdailyitem.mdx +++ b/docs/components/rankingsdailyitem.mdx @@ -6,6 +6,6 @@ title: "RankingsDailyItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `date_` | *str* | ✅ | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | -| `model_permaslug` | *str* | ✅ | 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 | -| `total_tokens` | *str* | ✅ | 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_` | *str* | :heavy_check_mark: | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | +| `model_permaslug` | *str* | :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 | +| `total_tokens` | *str* | :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/components/rankingsdailymeta.mdx b/docs/components/rankingsdailymeta.mdx index e690835d0..de87408be 100644 --- a/docs/components/rankingsdailymeta.mdx +++ b/docs/components/rankingsdailymeta.mdx @@ -6,7 +6,7 @@ title: "RankingsDailyMeta" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `as_of` | *str* | ✅ | 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 | -| `end_date` | *str* | ✅ | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | -| `start_date` | *str* | ✅ | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | -| `version` | [components.RankingsDailyMetaVersion](../components/rankingsdailymetaversion.mdx) | ✅ | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file +| `as_of` | *str* | :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 | +| `end_date` | *str* | :heavy_check_mark: | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | +| `start_date` | *str* | :heavy_check_mark: | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | +| `version` | [components.RankingsDailyMetaVersion](../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/components/rankingsdailyresponse.mdx b/docs/components/rankingsdailyresponse.mdx index 17a75ac0a..ff97dff4b 100644 --- a/docs/components/rankingsdailyresponse.mdx +++ b/docs/components/rankingsdailyresponse.mdx @@ -6,5 +6,5 @@ title: "RankingsDailyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.RankingsDailyItem](../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](../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` | List[[components.RankingsDailyItem](../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](../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/components/reasoningconfig.mdx b/docs/components/reasoningconfig.mdx index a91acea9b..12bc5225a 100644 --- a/docs/components/reasoningconfig.mdx +++ b/docs/components/reasoningconfig.mdx @@ -6,9 +6,9 @@ title: "ReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context` | [OptionalNullable[components.ReasoningContext]](../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[components.ReasoningEffort]](../components/reasoningeffort.mdx) | ➖ | N/A | medium | -| `mode` | [OptionalNullable[components.ReasoningMode]](../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[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.mdx) | ➖ | N/A | auto | -| `enabled` | *OptionalNullable[bool]* | ➖ | N/A | | -| `max_tokens` | *OptionalNullable[int]* | ➖ | N/A | | \ No newline at end of file +| `context` | [OptionalNullable[components.ReasoningContext]](../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[components.ReasoningEffort]](../components/reasoningeffort.mdx) | :heavy_minus_sign: | N/A | medium | +| `mode` | [OptionalNullable[components.ReasoningMode]](../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[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.mdx) | :heavy_minus_sign: | N/A | auto | +| `enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdeltaevent.mdx b/docs/components/reasoningdeltaevent.mdx index dc086e31d..2c29c423c 100644 --- a/docs/components/reasoningdeltaevent.mdx +++ b/docs/components/reasoningdeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning text delta is streamed | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `content_index` | *int* | ✅ | N/A | -| `delta` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.ReasoningDeltaEventType](../components/reasoningdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content_index` | *int* | :heavy_check_mark: | N/A | +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ReasoningDeltaEventType](../components/reasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/reasoningdetailencrypted.mdx b/docs/components/reasoningdetailencrypted.mdx index 01662d419..af4cce611 100644 --- a/docs/components/reasoningdetailencrypted.mdx +++ b/docs/components/reasoningdetailencrypted.mdx @@ -9,8 +9,8 @@ Reasoning detail encrypted schema | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `data` | *str* | ✅ | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `index` | *Optional[int]* | ➖ | N/A | | -| `type` | [components.ReasoningDetailEncryptedType](../components/reasoningdetailencryptedtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `data` | *str* | :heavy_check_mark: | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `type` | [components.ReasoningDetailEncryptedType](../components/reasoningdetailencryptedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdetailservertoolcall.mdx b/docs/components/reasoningdetailservertoolcall.mdx index a66597535..78f316a13 100644 --- a/docs/components/reasoningdetailservertoolcall.mdx +++ b/docs/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` | *str* | ✅ | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `index` | *Optional[int]* | ➖ | N/A | | -| `result` | *str* | ✅ | N/A | | -| `tool_call_id` | *OptionalNullable[str]* | ➖ | N/A | | -| `tool_name` | *str* | ✅ | N/A | | -| `type` | [components.ReasoningDetailServerToolCallType](../components/reasoningdetailservertoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `arguments` | *str* | :heavy_check_mark: | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `result` | *str* | :heavy_check_mark: | N/A | | +| `tool_call_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `tool_name` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.ReasoningDetailServerToolCallType](../components/reasoningdetailservertoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdetailsummary.mdx b/docs/components/reasoningdetailsummary.mdx index 2f6342726..f0ad47f1d 100644 --- a/docs/components/reasoningdetailsummary.mdx +++ b/docs/components/reasoningdetailsummary.mdx @@ -9,8 +9,8 @@ Reasoning detail summary schema | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `index` | *Optional[int]* | ➖ | N/A | | -| `summary` | *str* | ✅ | N/A | | -| `type` | [components.ReasoningDetailSummaryType](../components/reasoningdetailsummarytype.mdx) | ✅ | N/A | | \ No newline at end of file +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `summary` | *str* | :heavy_check_mark: | N/A | | +| `type` | [components.ReasoningDetailSummaryType](../components/reasoningdetailsummarytype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdetailtext.mdx b/docs/components/reasoningdetailtext.mdx index df5a9e85c..54a6696ff 100644 --- a/docs/components/reasoningdetailtext.mdx +++ b/docs/components/reasoningdetailtext.mdx @@ -9,9 +9,9 @@ Reasoning detail text schema | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `index` | *Optional[int]* | ➖ | N/A | | -| `signature` | *OptionalNullable[str]* | ➖ | N/A | | -| `text` | *OptionalNullable[str]* | ➖ | N/A | | -| `type` | [components.ReasoningDetailTextType](../components/reasoningdetailtexttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `text` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `type` | [components.ReasoningDetailTextType](../components/reasoningdetailtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdoneevent.mdx b/docs/components/reasoningdoneevent.mdx index a3f67ab02..6068c9df0 100644 --- a/docs/components/reasoningdoneevent.mdx +++ b/docs/components/reasoningdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning text streaming is complete | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `content_index` | *int* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `text` | *str* | ✅ | N/A | -| `type` | [components.ReasoningDoneEventType](../components/reasoningdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content_index` | *int* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ReasoningDoneEventType](../components/reasoningdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/reasoningitem.mdx b/docs/components/reasoningitem.mdx index a8d6e8faa..1afe61896 100644 --- a/docs/components/reasoningitem.mdx +++ b/docs/components/reasoningitem.mdx @@ -9,11 +9,11 @@ Reasoning output item with signature and format extensions | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | ➖ | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | -| `id` | *str* | ✅ | N/A | | -| `status` | [Optional[components.ReasoningItemStatusUnion]](../components/reasoningitemstatusunion.mdx) | ➖ | N/A | | -| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | ✅ | N/A | | -| `type` | [components.ReasoningItemType](../components/reasoningitemtype.mdx) | ✅ | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | -| `signature` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `status` | [Optional[components.ReasoningItemStatusUnion]](../components/reasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | +| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | :heavy_check_mark: | N/A | | +| `type` | [components.ReasoningItemType](../components/reasoningitemtype.mdx) | :heavy_check_mark: | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningsummarypartaddedevent.mdx b/docs/components/reasoningsummarypartaddedevent.mdx index be5cc403b..277f61694 100644 --- a/docs/components/reasoningsummarypartaddedevent.mdx +++ b/docs/components/reasoningsummarypartaddedevent.mdx @@ -9,9 +9,9 @@ Event emitted when a reasoning summary part is added | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | | -| `output_index` | *int* | ✅ | N/A | | -| `part` | [components.ReasoningSummaryText](../components/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `sequence_number` | *int* | ✅ | N/A | | -| `summary_index` | *int* | ✅ | N/A | | -| `type` | [components.ReasoningSummaryPartAddedEventType](../components/reasoningsummarypartaddedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | | +| `output_index` | *int* | :heavy_check_mark: | N/A | | +| `part` | [components.ReasoningSummaryText](../components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `summary_index` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.ReasoningSummaryPartAddedEventType](../components/reasoningsummarypartaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningsummarypartdoneevent.mdx b/docs/components/reasoningsummarypartdoneevent.mdx index 507d13031..f648a1e1b 100644 --- a/docs/components/reasoningsummarypartdoneevent.mdx +++ b/docs/components/reasoningsummarypartdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when a reasoning summary part is complete | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | | -| `output_index` | *int* | ✅ | N/A | | -| `part` | [components.ReasoningSummaryText](../components/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `sequence_number` | *int* | ✅ | N/A | | -| `summary_index` | *int* | ✅ | N/A | | -| `type` | [components.ReasoningSummaryPartDoneEventType](../components/reasoningsummarypartdoneeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | | +| `output_index` | *int* | :heavy_check_mark: | N/A | | +| `part` | [components.ReasoningSummaryText](../components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `summary_index` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.ReasoningSummaryPartDoneEventType](../components/reasoningsummarypartdoneeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningsummarytext.mdx b/docs/components/reasoningsummarytext.mdx index a64a277d9..0a97676ea 100644 --- a/docs/components/reasoningsummarytext.mdx +++ b/docs/components/reasoningsummarytext.mdx @@ -6,5 +6,5 @@ title: "ReasoningSummaryText" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `text` | *str* | ✅ | N/A | -| `type` | [components.ReasoningSummaryTextType](../components/reasoningsummarytexttype.mdx) | ✅ | N/A | \ No newline at end of file +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ReasoningSummaryTextType](../components/reasoningsummarytexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/reasoningsummarytextdeltaevent.mdx b/docs/components/reasoningsummarytextdeltaevent.mdx index 94b864749..204b30efe 100644 --- a/docs/components/reasoningsummarytextdeltaevent.mdx +++ b/docs/components/reasoningsummarytextdeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning summary text delta is streamed | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `delta` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `summary_index` | *int* | ✅ | N/A | -| `type` | [components.ReasoningSummaryTextDeltaEventType](../components/reasoningsummarytextdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `summary_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ReasoningSummaryTextDeltaEventType](../components/reasoningsummarytextdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/reasoningsummarytextdoneevent.mdx b/docs/components/reasoningsummarytextdoneevent.mdx index f7c46fc58..540a20cea 100644 --- a/docs/components/reasoningsummarytextdoneevent.mdx +++ b/docs/components/reasoningsummarytextdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning summary text streaming is complete | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `summary_index` | *int* | ✅ | N/A | -| `text` | *str* | ✅ | N/A | -| `type` | [components.ReasoningSummaryTextDoneEventType](../components/reasoningsummarytextdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `summary_index` | *int* | :heavy_check_mark: | N/A | +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ReasoningSummaryTextDoneEventType](../components/reasoningsummarytextdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/reasoningtextcontent.mdx b/docs/components/reasoningtextcontent.mdx index 215b59360..6fbaeeed4 100644 --- a/docs/components/reasoningtextcontent.mdx +++ b/docs/components/reasoningtextcontent.mdx @@ -6,5 +6,5 @@ title: "ReasoningTextContent" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `text` | *str* | ✅ | N/A | -| `type` | [components.ReasoningTextContentType](../components/reasoningtextcontenttype.mdx) | ✅ | N/A | \ No newline at end of file +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ReasoningTextContentType](../components/reasoningtextcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/refusal.mdx b/docs/components/refusal.mdx index 1d5fb3a2d..2d1c89c34 100644 --- a/docs/components/refusal.mdx +++ b/docs/components/refusal.mdx @@ -6,7 +6,7 @@ title: "Refusal" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | ✅ | N/A | -| `logprob` | *float* | ✅ | N/A | -| `token` | *str* | ✅ | N/A | -| `top_logprobs` | List[[components.RefusalTopLogprob](../components/refusaltoplogprob.mdx)] | ✅ | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | +| `logprob` | *float* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | +| `top_logprobs` | List[[components.RefusalTopLogprob](../components/refusaltoplogprob.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/refusaldeltaevent.mdx b/docs/components/refusaldeltaevent.mdx index ece0d48dd..046947a1c 100644 --- a/docs/components/refusaldeltaevent.mdx +++ b/docs/components/refusaldeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when a refusal delta is streamed | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `content_index` | *int* | ✅ | N/A | -| `delta` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.RefusalDeltaEventType](../components/refusaldeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content_index` | *int* | :heavy_check_mark: | N/A | +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.RefusalDeltaEventType](../components/refusaldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/refusaldoneevent.mdx b/docs/components/refusaldoneevent.mdx index a5adafc61..ccc2709f3 100644 --- a/docs/components/refusaldoneevent.mdx +++ b/docs/components/refusaldoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when refusal streaming is complete | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content_index` | *int* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `refusal` | *str* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.RefusalDoneEventType](../components/refusaldoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content_index` | *int* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `refusal` | *str* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.RefusalDoneEventType](../components/refusaldoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/refusaltoplogprob.mdx b/docs/components/refusaltoplogprob.mdx index b78b45e88..fa0f7cb0a 100644 --- a/docs/components/refusaltoplogprob.mdx +++ b/docs/components/refusaltoplogprob.mdx @@ -6,6 +6,6 @@ title: "RefusalTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | ✅ | N/A | -| `logprob` | *float* | ✅ | N/A | -| `token` | *str* | ✅ | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | +| `logprob` | *float* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/request.mdx b/docs/components/request.mdx index ffb4b0ee7..3ae4bc94d 100644 --- a/docs/components/request.mdx +++ b/docs/components/request.mdx @@ -6,5 +6,5 @@ title: "Request" | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `body` | Dict[str, *Any*] | ✅ | Request payload for the batch `endpoint`. | -| `custom_id` | *str* | ✅ | N/A | \ No newline at end of file +| `body` | Dict[str, *Any*] | :heavy_check_mark: | Request payload for the batch `endpoint`. | +| `custom_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/requesttimeoutresponseerrordata.mdx b/docs/components/requesttimeoutresponseerrordata.mdx index 410f61fae..711c93c9a 100644 --- a/docs/components/requesttimeoutresponseerrordata.mdx +++ b/docs/components/requesttimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for RequestTimeoutResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/requireapproval.mdx b/docs/components/requireapproval.mdx index 24f6adc5c..79583bfa0 100644 --- a/docs/components/requireapproval.mdx +++ b/docs/components/requireapproval.mdx @@ -6,5 +6,5 @@ title: "RequireApproval" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `always` | [Optional[components.Always]](../components/always.mdx) | ➖ | N/A | -| `never` | [Optional[components.Never]](../components/never.mdx) | ➖ | N/A | \ No newline at end of file +| `always` | [Optional[components.Always]](../components/always.mdx) | :heavy_minus_sign: | N/A | +| `never` | [Optional[components.Never]](../components/never.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/rerank.mdx b/docs/components/rerank.mdx index 36d364110..171e9c32d 100644 --- a/docs/components/rerank.mdx +++ b/docs/components/rerank.mdx @@ -6,6 +6,6 @@ title: "Rerank" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/responsehealingplugin.mdx b/docs/components/responsehealingplugin.mdx index 8e7bcf3f4..8b89cfa96 100644 --- a/docs/components/responsehealingplugin.mdx +++ b/docs/components/responsehealingplugin.mdx @@ -6,5 +6,5 @@ title: "ResponseHealingPlugin" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | ➖ | Set to false to disable the response-healing plugin for this request. Defaults to true. | -| `id` | [components.ResponseHealingPluginID](../components/responsehealingpluginid.mdx) | ✅ | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | +| `id` | [components.ResponseHealingPluginID](../components/responsehealingpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/responseoutputtext.mdx b/docs/components/responseoutputtext.mdx index 15fdc58b2..a6879aa83 100644 --- a/docs/components/responseoutputtext.mdx +++ b/docs/components/responseoutputtext.mdx @@ -6,7 +6,7 @@ title: "ResponseOutputText" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `annotations` | List[[components.OpenAIResponsesAnnotation](../components/openairesponsesannotation.mdx)] | ➖ | N/A | -| `logprobs` | List[[components.Logprob](../components/logprob.mdx)] | ➖ | N/A | -| `text` | *str* | ✅ | N/A | -| `type` | [components.ResponseOutputTextType](../components/responseoutputtexttype.mdx) | ✅ | N/A | \ No newline at end of file +| `annotations` | List[[components.OpenAIResponsesAnnotation](../components/openairesponsesannotation.mdx)] | :heavy_minus_sign: | N/A | +| `logprobs` | List[[components.Logprob](../components/logprob.mdx)] | :heavy_minus_sign: | N/A | +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.ResponseOutputTextType](../components/responseoutputtexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/responseoutputtexttoplogprob.mdx b/docs/components/responseoutputtexttoplogprob.mdx index 05261c077..b085f1887 100644 --- a/docs/components/responseoutputtexttoplogprob.mdx +++ b/docs/components/responseoutputtexttoplogprob.mdx @@ -6,6 +6,6 @@ title: "ResponseOutputTextTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | ✅ | N/A | -| `logprob` | *float* | ✅ | N/A | -| `token` | *str* | ✅ | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | +| `logprob` | *float* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/responsesrequest.mdx b/docs/components/responsesrequest.mdx index 0cc9ad025..d048ec2db 100644 --- a/docs/components/responsesrequest.mdx +++ b/docs/components/responsesrequest.mdx @@ -9,43 +9,43 @@ Request schema for Responses endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *OptionalNullable[bool]* | ➖ | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.ChatDebugOptions]](../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](../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` | List[[components.ResponseIncludesEnum](../components/responseincludesenum.mdx)] | ➖ | N/A | | -| `input` | [Optional[components.InputsUnion]](../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[str]* | ➖ | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | ➖ | 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` | Dict[str, *str*] | ➖ | 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` | List[[components.OutputModalityEnum](../components/outputmodalityenum.mdx)] | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | ➖ | N/A | | -| `models` | List[*str*] | ➖ | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | ➖ | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](../components/responsesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | | -| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../components/reasoningconfig.mdx) | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | ➖ | 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 | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../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. | | -| `session_id` | *Optional[str]* | ➖ | 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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[Literal[False]]* | ➖ | N/A | | -| `stream` | *Optional[bool]* | ➖ | N/A | | -| `temperature` | *OptionalNullable[float]* | ➖ | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](../components/responsesrequesttoolunion.mdx)] | ➖ | N/A | | -| `top_k` | *Optional[int]* | ➖ | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | ➖ | N/A | | -| `top_p` | *OptionalNullable[float]* | ➖ | N/A | | -| `trace` | [Optional[components.TraceConfig]](../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[components.OpenAIResponsesTruncation]](../components/openairesponsestruncation.mdx) | ➖ | N/A | auto | -| `user` | *Optional[str]* | ➖ | 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[bool]* | :heavy_minus_sign: | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.ChatDebugOptions]](../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `image_config` | Dict[str, [components.ImageConfig](../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` | List[[components.ResponseIncludesEnum](../components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | +| `input` | [Optional[components.InputsUnion]](../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[str]* | :heavy_minus_sign: | N/A | | +| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | :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` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](../components/outputmodalityenum.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `models` | List[*str*] | :heavy_minus_sign: | N/A | | +| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `plugins` | List[[components.ResponsesRequestPlugin](../components/responsesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../components/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | :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 | +| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../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. | | +| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[Literal[False]]* | :heavy_minus_sign: | N/A | | +| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | +| `tools` | List[[components.ResponsesRequestToolUnion](../components/responsesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | +| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `trace` | [Optional[components.TraceConfig]](../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[components.OpenAIResponsesTruncation]](../components/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | +| `user` | *Optional[str]* | :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/components/responsesrequesttoolfunction.mdx b/docs/components/responsesrequesttoolfunction.mdx index 026cd6904..4eeb6ce10 100644 --- a/docs/components/responsesrequesttoolfunction.mdx +++ b/docs/components/responsesrequesttoolfunction.mdx @@ -9,12 +9,12 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `parameters` | Dict[str, *Any*] | ✅ | N/A | | -| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | -| `type` | [components.ResponsesRequestType](../components/responsesrequesttype.mdx) | ✅ | N/A | | -| `allowed_callers` | List[[components.ResponsesRequestAllowedCaller](../components/responsesrequestallowedcaller.mdx)] | ➖ | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | -| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | \ No newline at end of file +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `parameters` | Dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `type` | [components.ResponsesRequestType](../components/responsesrequesttype.mdx) | :heavy_check_mark: | N/A | | +| `allowed_callers` | List[[components.ResponsesRequestAllowedCaller](../components/responsesrequestallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | +| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/responsesstreamingresponse.mdx b/docs/components/responsesstreamingresponse.mdx index d05862638..2d97adfb5 100644 --- a/docs/components/responsesstreamingresponse.mdx +++ b/docs/components/responsesstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ResponsesStreamingResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.StreamEvents](../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](../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/components/result.mdx b/docs/components/result.mdx index f587c66d3..77ee48483 100644 --- a/docs/components/result.mdx +++ b/docs/components/result.mdx @@ -6,7 +6,7 @@ title: "Result" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `custom_id` | *str* | ✅ | N/A | -| `error` | [Nullable[components.ResultError]](../components/resulterror.mdx) | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `response` | [Nullable[components.BatchObjectResponse]](../components/batchobjectresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `custom_id` | *str* | :heavy_check_mark: | N/A | +| `error` | [Nullable[components.ResultError]](../components/resulterror.mdx) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `response` | [Nullable[components.BatchObjectResponse]](../components/batchobjectresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/resulterror.mdx b/docs/components/resulterror.mdx index 403fb0b79..2609a9af0 100644 --- a/docs/components/resulterror.mdx +++ b/docs/components/resulterror.mdx @@ -6,7 +6,7 @@ title: "ResultError" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `error_type` | [Optional[components.APIErrorType]](../components/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `message` | *str* | ✅ | N/A | | -| `param` | *Nullable[str]* | ✅ | N/A | | -| `type` | *str* | ✅ | N/A | | \ No newline at end of file +| `error_type` | [Optional[components.APIErrorType]](../components/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `message` | *str* | :heavy_check_mark: | N/A | | +| `param` | *Nullable[str]* | :heavy_check_mark: | N/A | | +| `type` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/routerattempt.mdx b/docs/components/routerattempt.mdx index a30441233..a082fd19f 100644 --- a/docs/components/routerattempt.mdx +++ b/docs/components/routerattempt.mdx @@ -6,6 +6,6 @@ title: "RouterAttempt" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | ✅ | N/A | -| `provider` | *str* | ✅ | N/A | -| `status` | *int* | ✅ | N/A | \ No newline at end of file +| `model` | *str* | :heavy_check_mark: | N/A | +| `provider` | *str* | :heavy_check_mark: | N/A | +| `status` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/routerparams.mdx b/docs/components/routerparams.mdx index 1445db222..5354eeb9d 100644 --- a/docs/components/routerparams.mdx +++ b/docs/components/routerparams.mdx @@ -6,7 +6,7 @@ title: "RouterParams" | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `quality_floor` | *Optional[float]* | ➖ | N/A | | -| `throughput_floor` | *Optional[float]* | ➖ | N/A | | -| `version_group` | *Optional[str]* | ➖ | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file +| `quality_floor` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `throughput_floor` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `version_group` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file diff --git a/docs/components/rule.mdx b/docs/components/rule.mdx index bb99c7c7e..14a9f7136 100644 --- a/docs/components/rule.mdx +++ b/docs/components/rule.mdx @@ -6,6 +6,6 @@ title: "Rule" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `field` | [components.FieldT](../components/fieldt.mdx) | ✅ | N/A | -| `operator` | [components.Operator](../components/operator.mdx) | ✅ | N/A | -| `value` | [Optional[components.ObservabilityFilterRuleGroupValue]](../components/observabilityfilterrulegroupvalue.mdx) | ➖ | N/A | \ No newline at end of file +| `field` | [components.FieldT](../components/fieldt.mdx) | :heavy_check_mark: | N/A | +| `operator` | [components.Operator](../components/operator.mdx) | :heavy_check_mark: | N/A | +| `value` | [Optional[components.ObservabilityFilterRuleGroupValue]](../components/observabilityfilterrulegroupvalue.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/scimgroup.mdx b/docs/components/scimgroup.mdx index 656c386c2..98a3dfc33 100644 --- a/docs/components/scimgroup.mdx +++ b/docs/components/scimgroup.mdx @@ -6,9 +6,9 @@ title: "ScimGroup" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `created_at` | *str* | ✅ | N/A | -| `display_name` | *str* | ✅ | N/A | -| `external_id` | *Nullable[str]* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `organization_id` | *str* | ✅ | N/A | -| `updated_at` | *str* | ✅ | N/A | \ No newline at end of file +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `display_name` | *str* | :heavy_check_mark: | N/A | +| `external_id` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `organization_id` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/scimgroupmapping.mdx b/docs/components/scimgroupmapping.mdx index 509ea63f2..a1ee91fad 100644 --- a/docs/components/scimgroupmapping.mdx +++ b/docs/components/scimgroupmapping.mdx @@ -6,10 +6,10 @@ title: "ScimGroupMapping" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `created_at` | *str* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `organization_id` | *str* | ✅ | N/A | -| `role` | [components.ScimGroupMappingRole](../components/scimgroupmappingrole.mdx) | ✅ | N/A | -| `scim_group_id` | *str* | ✅ | N/A | -| `updated_at` | *str* | ✅ | N/A | -| `workspace_id` | *str* | ✅ | N/A | \ No newline at end of file +| `created_at` | *str* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `organization_id` | *str* | :heavy_check_mark: | N/A | +| `role` | [components.ScimGroupMappingRole](../components/scimgroupmappingrole.mdx) | :heavy_check_mark: | N/A | +| `scim_group_id` | *str* | :heavy_check_mark: | N/A | +| `updated_at` | *str* | :heavy_check_mark: | N/A | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/scimsyncjob.mdx b/docs/components/scimsyncjob.mdx index f6c7d4965..8d852b658 100644 --- a/docs/components/scimsyncjob.mdx +++ b/docs/components/scimsyncjob.mdx @@ -6,11 +6,11 @@ title: "ScimSyncJob" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `created_at` | *str* | ✅ | Time when the sync job was created. | -| `deleted_groups` | *Nullable[int]* | ✅ | Number of groups deleted, when the job completed successfully. | -| `error_message` | *Nullable[str]* | ✅ | Stable error message when the job failed. | -| `finished_at` | *Nullable[str]* | ✅ | Time when synchronization finished. | -| `id` | *str* | ✅ | Unique identifier for the sync job. | -| `started_at` | *Nullable[str]* | ✅ | Time when synchronization started. | -| `status` | [components.ScimSyncJobStatus](../components/scimsyncjobstatus.mdx) | ✅ | Current status of the sync job: queued, running, succeeded, or failed. | -| `synced_groups` | *Nullable[int]* | ✅ | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file +| `created_at` | *str* | :heavy_check_mark: | Time when the sync job was created. | +| `deleted_groups` | *Nullable[int]* | :heavy_check_mark: | Number of groups deleted, when the job completed successfully. | +| `error_message` | *Nullable[str]* | :heavy_check_mark: | Stable error message when the job failed. | +| `finished_at` | *Nullable[str]* | :heavy_check_mark: | Time when synchronization finished. | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the sync job. | +| `started_at` | *Nullable[str]* | :heavy_check_mark: | Time when synchronization started. | +| `status` | [components.ScimSyncJobStatus](../components/scimsyncjobstatus.mdx) | :heavy_check_mark: | Current status of the sync job: queued, running, succeeded, or failed. | +| `synced_groups` | *Nullable[int]* | :heavy_check_mark: | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file diff --git a/docs/components/searchmodelsservertoolconfig.mdx b/docs/components/searchmodelsservertoolconfig.mdx index dd714332e..fb2f7f7c5 100644 --- a/docs/components/searchmodelsservertoolconfig.mdx +++ b/docs/components/searchmodelsservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:experimental__search_models server tool | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `max_results` | *Optional[int]* | ➖ | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file +| `max_results` | *Optional[int]* | :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/components/searchmodelsservertoolopenrouter.mdx b/docs/components/searchmodelsservertoolopenrouter.mdx index b7682c421..e72c5e1cd 100644 --- a/docs/components/searchmodelsservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [components.SearchModelsServerToolOpenRouterType](../components/searchmodelsservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [components.SearchModelsServerToolOpenRouterType](../components/searchmodelsservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/security.mdx b/docs/components/security.mdx index e0340d2c2..185abbfd5 100644 --- a/docs/components/security.mdx +++ b/docs/components/security.mdx @@ -6,4 +6,4 @@ title: "Security" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `api_key` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/servertool.mdx b/docs/components/servertool.mdx index 61fd5f7df..8f8f0d4e9 100644 --- a/docs/components/servertool.mdx +++ b/docs/components/servertool.mdx @@ -6,18 +6,18 @@ title: "ServerTool" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aliases` | List[[components.ServerToolInputName](../components/servertoolinputname.mdx)] | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | -| `default_engine` | *Nullable[str]* | ✅ | 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 | -| `docs_url` | *str* | ✅ | N/A | | -| `engines` | List[[components.ServerToolEngine](../components/servertoolengine.mdx)] | ✅ | N/A | | -| `fallback_engine` | *Nullable[str]* | ✅ | 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` | *str* | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `input_schema` | Dict[str, *Any*] | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `name` | *str* | ✅ | N/A | Web search | -| `native_support` | [components.ServerToolNativeSupport](../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
} | -| `output_schema` | Dict[str, *Any*] | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `parameters_schema` | Dict[str, *Any*] | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `status` | [components.ServerToolStatus](../components/servertoolstatus.mdx) | ✅ | N/A | active | -| `summary` | *str* | ✅ | One sentence for cards and search results; never sent to a model | | -| `supported_api_formats` | List[[components.ServerToolSupportedAPIFormat](../components/servertoolsupportedapiformat.mdx)] | ✅ | N/A | | -| `tool_description` | *str* | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file +| `aliases` | List[[components.ServerToolInputName](../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 | | +| `default_engine` | *Nullable[str]* | :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 | +| `docs_url` | *str* | :heavy_check_mark: | N/A | | +| `engines` | List[[components.ServerToolEngine](../components/servertoolengine.mdx)] | :heavy_check_mark: | N/A | | +| `fallback_engine` | *Nullable[str]* | :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` | *str* | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `input_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `name` | *str* | :heavy_check_mark: | N/A | Web search | +| `native_support` | [components.ServerToolNativeSupport](../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
} | +| `output_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `parameters_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `status` | [components.ServerToolStatus](../components/servertoolstatus.mdx) | :heavy_check_mark: | N/A | active | +| `summary` | *str* | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | +| `supported_api_formats` | List[[components.ServerToolSupportedAPIFormat](../components/servertoolsupportedapiformat.mdx)] | :heavy_check_mark: | N/A | | +| `tool_description` | *str* | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/components/servertooldetails.mdx b/docs/components/servertooldetails.mdx index 99b20b5d4..2ec8bf7ad 100644 --- a/docs/components/servertooldetails.mdx +++ b/docs/components/servertooldetails.mdx @@ -6,18 +6,18 @@ title: "ServerToolDetails" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aliases` | List[[components.ServerToolInputName](../components/servertoolinputname.mdx)] | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | -| `default_engine` | *Nullable[str]* | ✅ | 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 | -| `docs_url` | *str* | ✅ | N/A | | -| `engines` | List[[components.ServerToolEngine](../components/servertoolengine.mdx)] | ✅ | N/A | | -| `fallback_engine` | *Nullable[str]* | ✅ | 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` | *str* | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `input_schema` | Dict[str, *Any*] | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `name` | *str* | ✅ | N/A | Web search | -| `native_support` | [components.NativeSupport](../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
} | -| `output_schema` | Dict[str, *Any*] | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `parameters_schema` | Dict[str, *Any*] | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `status` | [components.ServerToolDetailsStatus](../components/servertooldetailsstatus.mdx) | ✅ | N/A | active | -| `summary` | *str* | ✅ | One sentence for cards and search results; never sent to a model | | -| `supported_api_formats` | List[[components.ServerToolDetailsSupportedAPIFormat](../components/servertooldetailssupportedapiformat.mdx)] | ✅ | N/A | | -| `tool_description` | *str* | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file +| `aliases` | List[[components.ServerToolInputName](../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 | | +| `default_engine` | *Nullable[str]* | :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 | +| `docs_url` | *str* | :heavy_check_mark: | N/A | | +| `engines` | List[[components.ServerToolEngine](../components/servertoolengine.mdx)] | :heavy_check_mark: | N/A | | +| `fallback_engine` | *Nullable[str]* | :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` | *str* | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `input_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `name` | *str* | :heavy_check_mark: | N/A | Web search | +| `native_support` | [components.NativeSupport](../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
} | +| `output_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `parameters_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `status` | [components.ServerToolDetailsStatus](../components/servertooldetailsstatus.mdx) | :heavy_check_mark: | N/A | active | +| `summary` | *str* | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | +| `supported_api_formats` | List[[components.ServerToolDetailsSupportedAPIFormat](../components/servertooldetailssupportedapiformat.mdx)] | :heavy_check_mark: | N/A | | +| `tool_description` | *str* | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/components/servertoolengine.mdx b/docs/components/servertoolengine.mdx index 2bd6f9462..65e059679 100644 --- a/docs/components/servertoolengine.mdx +++ b/docs/components/servertoolengine.mdx @@ -6,12 +6,12 @@ title: "ServerToolEngine" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok` | [components.BYOK](../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 | -| `data_regions` | List[[components.ServerToolEngineDataRegion](../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"
] | -| `default_mode` | *Nullable[str]* | ✅ | 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 | -| `executed_by` | [components.ServerToolExecutedBy](../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` | *Nullable[str]* | ✅ | The `parameters.engine` value that selects this engine; null for the single engine of a tool without an engine parameter | exa | -| `name` | *str* | ✅ | N/A | Exa | -| `pricing` | List[[components.ServerToolPrice](../components/servertoolprice.mdx)] | ✅ | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | -| `pricing_doc_url` | *Nullable[str]* | ✅ | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | -| `pricing_source` | [components.PricingSource](../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](../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 | +| `data_regions` | List[[components.ServerToolEngineDataRegion](../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"
] | +| `default_mode` | *Nullable[str]* | :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 | +| `executed_by` | [components.ServerToolExecutedBy](../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` | *Nullable[str]* | :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` | *str* | :heavy_check_mark: | N/A | Exa | +| `pricing` | List[[components.ServerToolPrice](../components/servertoolprice.mdx)] | :heavy_check_mark: | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | +| `pricing_doc_url` | *Nullable[str]* | :heavy_check_mark: | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | +| `pricing_source` | [components.PricingSource](../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/components/servertoolinputname.mdx b/docs/components/servertoolinputname.mdx index 5a6ad4820..24c135128 100644 --- a/docs/components/servertoolinputname.mdx +++ b/docs/components/servertoolinputname.mdx @@ -6,6 +6,6 @@ title: "ServerToolInputName" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_formats` | List[[components.ServerToolInputNameAPIFormat](../components/servertoolinputnameapiformat.mdx)] | ✅ | API formats that accept this spelling in `tools[].type` | | -| `output_names` | List[[components.ServerToolOutputName](../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` | *str* | ✅ | N/A | web_search_20250305 | \ No newline at end of file +| `api_formats` | List[[components.ServerToolInputNameAPIFormat](../components/servertoolinputnameapiformat.mdx)] | :heavy_check_mark: | API formats that accept this spelling in `tools[].type` | | +| `output_names` | List[[components.ServerToolOutputName](../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` | *str* | :heavy_check_mark: | N/A | web_search_20250305 | \ No newline at end of file diff --git a/docs/components/servertoolnativemodel.mdx b/docs/components/servertoolnativemodel.mdx index 865246d37..5cd668a08 100644 --- a/docs/components/servertoolnativemodel.mdx +++ b/docs/components/servertoolnativemodel.mdx @@ -6,5 +6,5 @@ title: "ServerToolNativeModel" | Field | Type | Required | Description | Example | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `providers` | List[*str*] | ✅ | N/A | [
"Anthropic",
"Google"
] | -| `slug` | *str* | ✅ | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file +| `providers` | List[*str*] | :heavy_check_mark: | N/A | [
"Anthropic",
"Google"
] | +| `slug` | *str* | :heavy_check_mark: | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file diff --git a/docs/components/servertoolnativesupport.mdx b/docs/components/servertoolnativesupport.mdx index b2fcadc8a..b746ac366 100644 --- a/docs/components/servertoolnativesupport.mdx +++ b/docs/components/servertoolnativesupport.mdx @@ -9,5 +9,5 @@ Endpoints whose provider runs this tool itself during inference. Zero for tools | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `endpoint_count` | *int* | ✅ | N/A | 18 | -| `model_count` | *int* | ✅ | N/A | 12 | \ No newline at end of file +| `endpoint_count` | *int* | :heavy_check_mark: | N/A | 18 | +| `model_count` | *int* | :heavy_check_mark: | N/A | 12 | \ No newline at end of file diff --git a/docs/components/servertooloutputname.mdx b/docs/components/servertooloutputname.mdx index dec6dd515..1d29864ad 100644 --- a/docs/components/servertooloutputname.mdx +++ b/docs/components/servertooloutputname.mdx @@ -6,6 +6,6 @@ title: "ServerToolOutputName" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `api_format` | [components.ServerToolOutputNameAPIFormat](../components/servertooloutputnameapiformat.mdx) | ✅ | N/A | | -| `name` | *Optional[str]* | ➖ | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | -| `type` | *str* | ✅ | 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 +| `api_format` | [components.ServerToolOutputNameAPIFormat](../components/servertooloutputnameapiformat.mdx) | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_minus_sign: | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | +| `type` | *str* | :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/components/servertoolprice.mdx b/docs/components/servertoolprice.mdx index e77bceeb5..78fe83c07 100644 --- a/docs/components/servertoolprice.mdx +++ b/docs/components/servertoolprice.mdx @@ -6,7 +6,7 @@ title: "ServerToolPrice" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `max_units_per_call` | *int* | ✅ | N/A | | -| `mode` | *Nullable[str]* | ✅ | 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` | *str* | ✅ | USD per unit, as a decimal string | 0.007 | -| `unit` | *str* | ✅ | N/A | request | \ No newline at end of file +| `max_units_per_call` | *int* | :heavy_check_mark: | N/A | | +| `mode` | *Nullable[str]* | :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` | *str* | :heavy_check_mark: | USD per unit, as a decimal string | 0.007 | +| `unit` | *str* | :heavy_check_mark: | N/A | request | \ No newline at end of file diff --git a/docs/components/servertoolusedetails.mdx b/docs/components/servertoolusedetails.mdx index a25d35f96..de0d677d4 100644 --- a/docs/components/servertoolusedetails.mdx +++ b/docs/components/servertoolusedetails.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | -| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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 +| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | :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. | +| `web_search_requests` | *OptionalNullable[int]* | :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/components/serviceunavailableresponseerrordata.mdx b/docs/components/serviceunavailableresponseerrordata.mdx index 79cfeeffc..e4da707cb 100644 --- a/docs/components/serviceunavailableresponseerrordata.mdx +++ b/docs/components/serviceunavailableresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ServiceUnavailableResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/sessioncostitem.mdx b/docs/components/sessioncostitem.mdx index c329a3f7f..6bab396f0 100644 --- a/docs/components/sessioncostitem.mdx +++ b/docs/components/sessioncostitem.mdx @@ -6,8 +6,8 @@ title: "SessionCostItem" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `app_name` | *str* | ✅ | Published harness display label. | Hermes Agent | -| `app_slug` | *str* | ✅ | Stable public slug of the harness. | hermes-agent | -| `median_session_cost_usd` | *float* | ✅ | Median USD spend per sampled session. | 1.74 | -| `model_permaslug` | *str* | ✅ | Exact model permaslug. | anthropic/claude-4.8-opus | -| `turn_range` | [components.TurnRange](../components/turnrange.mdx) | ✅ | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file +| `app_name` | *str* | :heavy_check_mark: | Published harness display label. | Hermes Agent | +| `app_slug` | *str* | :heavy_check_mark: | Stable public slug of the harness. | hermes-agent | +| `median_session_cost_usd` | *float* | :heavy_check_mark: | Median USD spend per sampled session. | 1.74 | +| `model_permaslug` | *str* | :heavy_check_mark: | Exact model permaslug. | anthropic/claude-4.8-opus | +| `turn_range` | [components.TurnRange](../components/turnrange.mdx) | :heavy_check_mark: | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file diff --git a/docs/components/sessioncostmeta.mdx b/docs/components/sessioncostmeta.mdx index bfb4c473b..f27d0ca7b 100644 --- a/docs/components/sessioncostmeta.mdx +++ b/docs/components/sessioncostmeta.mdx @@ -6,7 +6,7 @@ title: "SessionCostMeta" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `as_of` | *str* | ✅ | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | -| `version` | [components.SessionCostMetaVersion](../components/sessioncostmetaversion.mdx) | ✅ | Dataset version. | | -| `window_days` | *Nullable[int]* | ✅ | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | -| `window_end_date` | *Nullable[str]* | ✅ | 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 +| `as_of` | *str* | :heavy_check_mark: | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | +| `version` | [components.SessionCostMetaVersion](../components/sessioncostmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | +| `window_days` | *Nullable[int]* | :heavy_check_mark: | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | +| `window_end_date` | *Nullable[str]* | :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/components/sessioncostresponse.mdx b/docs/components/sessioncostresponse.mdx index f52c308f4..4b94d8dff 100644 --- a/docs/components/sessioncostresponse.mdx +++ b/docs/components/sessioncostresponse.mdx @@ -6,5 +6,5 @@ title: "SessionCostResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | List[[components.SessionCostItem](../components/sessioncostitem.mdx)] | ✅ | N/A | -| `meta` | [components.SessionCostMeta](../components/sessioncostmeta.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.SessionCostItem](../components/sessioncostitem.mdx)] | :heavy_check_mark: | N/A | +| `meta` | [components.SessionCostMeta](../components/sessioncostmeta.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/shellcallitem.mdx b/docs/components/shellcallitem.mdx index 34ceee9dd..4e9f17f39 100644 --- a/docs/components/shellcallitem.mdx +++ b/docs/components/shellcallitem.mdx @@ -9,10 +9,10 @@ A shell command execution call (newer variant) | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [components.ShellCallItemAction](../components/shellcallitemaction.mdx) | ✅ | N/A | | -| `arguments` | *OptionalNullable[str]* | ➖ | 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. | | -| `call_id` | *str* | ✅ | N/A | | -| `environment` | *Optional[Any]* | ➖ | N/A | | -| `id` | *OptionalNullable[str]* | ➖ | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | -| `type` | [components.ShellCallItemType](../components/shellcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `action` | [components.ShellCallItemAction](../components/shellcallitemaction.mdx) | :heavy_check_mark: | N/A | | +| `arguments` | *OptionalNullable[str]* | :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. | | +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `environment` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | +| `type` | [components.ShellCallItemType](../components/shellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/shellcallitemaction.mdx b/docs/components/shellcallitemaction.mdx index b94bb6571..cca3bb614 100644 --- a/docs/components/shellcallitemaction.mdx +++ b/docs/components/shellcallitemaction.mdx @@ -6,6 +6,6 @@ title: "ShellCallItemAction" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `commands` | List[*str*] | ✅ | N/A | -| `max_output_length` | *OptionalNullable[int]* | ➖ | N/A | -| `timeout_ms` | *OptionalNullable[int]* | ➖ | N/A | \ No newline at end of file +| `commands` | List[*str*] | :heavy_check_mark: | N/A | +| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | +| `timeout_ms` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/shellcalloutputcontent.mdx b/docs/components/shellcalloutputcontent.mdx index c95451e8e..9aaa17fdf 100644 --- a/docs/components/shellcalloutputcontent.mdx +++ b/docs/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](../components/outcome.mdx) | ✅ | N/A | | -| `stderr` | *str* | ✅ | N/A | | -| `stdout` | *str* | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"outcome": \{
"exit_code": 0,
"type": "exit"
},
"stderr": "",
"stdout": "total 0\n"
} | \ No newline at end of file +| `outcome` | [components.Outcome](../components/outcome.mdx) | :heavy_check_mark: | N/A | | +| `stderr` | *str* | :heavy_check_mark: | N/A | | +| `stdout` | *str* | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/shellcalloutputitem.mdx b/docs/components/shellcalloutputitem.mdx index 3f614cd9a..05e53b1f6 100644 --- a/docs/components/shellcalloutputitem.mdx +++ b/docs/components/shellcalloutputitem.mdx @@ -9,12 +9,12 @@ Output from a shell command execution (newer variant) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | ✅ | N/A | | -| `container_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | The error message when the sandbox call failed before producing a result, as echoed from a failed `shell_call_output` emission. | | -| `files` | List[[components.ShellCallOutputItemFile](../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[str]* | ➖ | N/A | | -| `max_output_length` | *OptionalNullable[int]* | ➖ | N/A | | -| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | ✅ | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | -| `type` | [components.ShellCallOutputItemTypeShellCallOutput](../components/shellcalloutputitemtypeshellcalloutput.mdx) | ✅ | N/A | | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | | +| `container_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | List[[components.ShellCallOutputItemFile](../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[str]* | :heavy_minus_sign: | N/A | | +| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | :heavy_check_mark: | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | +| `type` | [components.ShellCallOutputItemTypeShellCallOutput](../components/shellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/shellcalloutputitemfile.mdx b/docs/components/shellcalloutputitemfile.mdx index 851268c18..e4a0c69ef 100644 --- a/docs/components/shellcalloutputitemfile.mdx +++ b/docs/components/shellcalloutputitemfile.mdx @@ -6,9 +6,9 @@ title: "ShellCallOutputItemFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | ✅ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `file_id` | *str* | ✅ | N/A | -| `filename` | *str* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `type` | [components.ShellCallOutputItemTypeContainerFileCitation](../components/shellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `container_id` | *str* | :heavy_check_mark: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `file_id` | *str* | :heavy_check_mark: | N/A | +| `filename` | *str* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ShellCallOutputItemTypeContainerFileCitation](../components/shellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/shellservertool.mdx b/docs/components/shellservertool.mdx index 8dd61d106..0f55c3798 100644 --- a/docs/components/shellservertool.mdx +++ b/docs/components/shellservertool.mdx @@ -9,4 +9,4 @@ Shell tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.ShellServerToolType](../components/shellservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.ShellServerToolType](../components/shellservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/shellservertoolconfig.mdx b/docs/components/shellservertoolconfig.mdx index 07ebb17f5..c42fbf09d 100644 --- a/docs/components/shellservertoolconfig.mdx +++ b/docs/components/shellservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:shell server tool | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.ShellServerToolEngine]](../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` | [Optional[components.ShellServerToolEnvironment]](../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` | [Optional[components.ShellServerToolEngine]](../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` | [Optional[components.ShellServerToolEnvironment]](../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/components/shellservertoolopenrouter.mdx b/docs/components/shellservertoolopenrouter.mdx index 990ac3f2c..fa031486a 100644 --- a/docs/components/shellservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.ShellServerToolConfig]](../components/shellservertoolconfig.mdx) | ➖ | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | -| `type` | [components.ShellServerToolOpenRouterType](../components/shellservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.ShellServerToolConfig]](../components/shellservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | +| `type` | [components.ShellServerToolOpenRouterType](../components/shellservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/signinterndaemonrequest.mdx b/docs/components/signinterndaemonrequest.mdx index 5ed4ce9b1..b4bf06967 100644 --- a/docs/components/signinterndaemonrequest.mdx +++ b/docs/components/signinterndaemonrequest.mdx @@ -6,4 +6,4 @@ title: "SignInternDaemonRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `body_sha256` | *str* | ✅ | 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 +| `body_sha256` | *str* | :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/components/signinterndaemonresponse.mdx b/docs/components/signinterndaemonresponse.mdx index 5da8e2eeb..d989162b0 100644 --- a/docs/components/signinterndaemonresponse.mdx +++ b/docs/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 | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `x_ori_invoke_signature` | *str* | ✅ | Base64 Ed25519 signature over the intern id, timestamp, user and body digest. | -| `x_ori_invoke_timestamp` | *str* | ✅ | Unix seconds at signing; the daemon refuses proofs older than its window. | -| `x_ori_invoke_user` | *str* | ✅ | The verified OAuth subject the proof names. Never taken from the request. | \ No newline at end of file +| `x_ori_invoke_signature` | *str* | :heavy_check_mark: | Base64 Ed25519 signature over the intern id, timestamp, user and body digest. | +| `x_ori_invoke_timestamp` | *str* | :heavy_check_mark: | Unix seconds at signing; the daemon refuses proofs older than its window. | +| `x_ori_invoke_user` | *str* | :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/components/sourcecontent.mdx b/docs/components/sourcecontent.mdx index d56b7247d..792f40542 100644 --- a/docs/components/sourcecontent.mdx +++ b/docs/components/sourcecontent.mdx @@ -6,5 +6,5 @@ title: "SourceContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `content` | [components.AnthropicDocumentBlockParamContent2](../components/anthropicdocumentblockparamcontent2.mdx) | ✅ | N/A | -| `type` | [components.SourceType](../components/sourcetype.mdx) | ✅ | N/A | \ No newline at end of file +| `content` | [components.AnthropicDocumentBlockParamContent2](../components/anthropicdocumentblockparamcontent2.mdx) | :heavy_check_mark: | N/A | +| `type` | [components.SourceType](../components/sourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/speechinput.mdx b/docs/components/speechinput.mdx index 948ee8455..45150512f 100644 --- a/docs/components/speechinput.mdx +++ b/docs/components/speechinput.mdx @@ -2,7 +2,7 @@ title: "SpeechInput" --- -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. +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 supported by Gemini TTS models and by Fish Audio models other than S1. ## Supported Types diff --git a/docs/components/speechinputreferenceaudio.mdx b/docs/components/speechinputreferenceaudio.mdx index 2526a8b5d..f00281d13 100644 --- a/docs/components/speechinputreferenceaudio.mdx +++ b/docs/components/speechinputreferenceaudio.mdx @@ -9,5 +9,5 @@ Reference audio input for stateless voice cloning. Up to three parts per request | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `input_audio` | [components.SpeechInputReferenceAudioInput](../components/speechinputreferenceaudioinput.mdx) | ✅ | Reference audio input object | -| `type` | [components.SpeechInputReferenceAudioType](../components/speechinputreferenceaudiotype.mdx) | ✅ | N/A | \ No newline at end of file +| `input_audio` | [components.SpeechInputReferenceAudioInput](../components/speechinputreferenceaudioinput.mdx) | :heavy_check_mark: | Reference audio input object | +| `type` | [components.SpeechInputReferenceAudioType](../components/speechinputreferenceaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/speechinputreferenceaudioinput.mdx b/docs/components/speechinputreferenceaudioinput.mdx index 671117175..c16ea82c8 100644 --- a/docs/components/speechinputreferenceaudioinput.mdx +++ b/docs/components/speechinputreferenceaudioinput.mdx @@ -9,6 +9,6 @@ Reference audio input object | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *Optional[str]* | ➖ | 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_` | *Optional[str]* | ➖ | Audio format of the reference audio (e.g., wav, mp3). Optional; most providers detect the format from the audio bytes. | wav | -| `url` | *Optional[str]* | ➖ | 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` | *Optional[str]* | :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_` | *Optional[str]* | :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` | *Optional[str]* | :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/components/speechinputreferenceimage.mdx b/docs/components/speechinputreferenceimage.mdx index c02d1d3cd..068290f70 100644 --- a/docs/components/speechinputreferenceimage.mdx +++ b/docs/components/speechinputreferenceimage.mdx @@ -9,5 +9,5 @@ Reference image describing the desired voice. Cannot be combined with `input_aud | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `image_url` | [components.SpeechInputReferenceImageInput](../components/speechinputreferenceimageinput.mdx) | ✅ | Reference image input object | -| `type` | [components.SpeechInputReferenceImageType](../components/speechinputreferenceimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `image_url` | [components.SpeechInputReferenceImageInput](../components/speechinputreferenceimageinput.mdx) | :heavy_check_mark: | Reference image input object | +| `type` | [components.SpeechInputReferenceImageType](../components/speechinputreferenceimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/speechinputreferenceimageinput.mdx b/docs/components/speechinputreferenceimageinput.mdx index 051444219..127f005a6 100644 --- a/docs/components/speechinputreferenceimageinput.mdx +++ b/docs/components/speechinputreferenceimageinput.mdx @@ -9,4 +9,4 @@ Reference image input object | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | *str* | ✅ | 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` | *str* | :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/components/speechinputreferencetext.mdx b/docs/components/speechinputreferencetext.mdx index 0e7869df3..af437e9f3 100644 --- a/docs/components/speechinputreferencetext.mdx +++ b/docs/components/speechinputreferencetext.mdx @@ -9,5 +9,5 @@ Transcript of an `input_audio` part | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `text` | *str* | ✅ | 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](../components/speechinputreferencetexttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `text` | *str* | :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](../components/speechinputreferencetexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/speechrequest.mdx b/docs/components/speechrequest.mdx index 67b7322c1..e87bc0ab2 100644 --- a/docs/components/speechrequest.mdx +++ b/docs/components/speechrequest.mdx @@ -9,14 +9,14 @@ Text-to-speech request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `input` | [components.SpeechInput](../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 | -| `input_references` | List[[components.SpeechInputReference](../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` | *Optional[str]* | ➖ | 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` | *str* | ✅ | TTS model identifier | mistralai/voxtral-mini-tts-2603 | -| `provider` | [Optional[components.SpeechRequestProvider]](../components/speechrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `response_format` | [Optional[components.SpeechRequestResponseFormat]](../components/speechrequestresponseformat.mdx) | ➖ | Audio output format | pcm | -| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | 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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file +| `input` | [components.SpeechInput](../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 supported by Gemini TTS models and by Fish Audio models other than S1. | Hello world | +| `input_references` | List[[components.SpeechInputReference](../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` | *Optional[str]* | :heavy_minus_sign: | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers. | Speak in a warm and friendly tone. | +| `model` | *str* | :heavy_check_mark: | TTS model identifier | mistralai/voxtral-mini-tts-2603 | +| `provider` | [Optional[components.SpeechRequestProvider]](../components/speechrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `response_format` | [Optional[components.SpeechRequestResponseFormat]](../components/speechrequestresponseformat.mdx) | :heavy_minus_sign: | Audio output format | pcm | +| `session_id` | *Optional[str]* | :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` | *Optional[float]* | :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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file diff --git a/docs/components/speechrequestprovider.mdx b/docs/components/speechrequestprovider.mdx index f2d851d2e..fbfa71493 100644 --- a/docs/components/speechrequestprovider.mdx +++ b/docs/components/speechrequestprovider.mdx @@ -9,6 +9,6 @@ Provider configuration: data policy routing preferences (`zdr`, `data_collection | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data_collection` | [OptionalNullable[components.SpeechRequestDataCollection]](../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` | [Optional[components.ProviderOptions]](../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[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 +| `data_collection` | [OptionalNullable[components.SpeechRequestDataCollection]](../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` | [Optional[components.ProviderOptions]](../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[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/components/speechturn.mdx b/docs/components/speechturn.mdx index 2297b61a5..db37aa4e7 100644 --- a/docs/components/speechturn.mdx +++ b/docs/components/speechturn.mdx @@ -6,6 +6,6 @@ title: "SpeechTurn" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `instructions` | *Optional[str]* | ➖ | Delivery instructions for this turn, such as tone, pacing, or emotion. Overrides the top-level `instructions`. | whispering | -| `text` | *str* | ✅ | Text to synthesize | Hi Jane. | -| `voice` | *Optional[str]* | ➖ | Voice for this turn. Defaults to the top-level `voice`. | Kore | \ No newline at end of file +| `instructions` | *Optional[str]* | :heavy_minus_sign: | Delivery instructions for this turn, such as tone, pacing, or emotion. Overrides the top-level `instructions`. | whispering | +| `text` | *str* | :heavy_check_mark: | Text to synthesize | Hi Jane. | +| `voice` | *Optional[str]* | :heavy_minus_sign: | Voice for this turn. Defaults to the top-level `voice`. | Kore | \ No newline at end of file diff --git a/docs/components/stance.mdx b/docs/components/stance.mdx index e743de1e5..3a93298ea 100644 --- a/docs/components/stance.mdx +++ b/docs/components/stance.mdx @@ -6,5 +6,5 @@ title: "Stance" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | ✅ | N/A | -| `stance` | *str* | ✅ | N/A | \ No newline at end of file +| `model` | *str* | :heavy_check_mark: | N/A | +| `stance` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenfinishreasonis.mdx b/docs/components/stopservertoolswhenfinishreasonis.mdx index bf4741108..ef2f143f7 100644 --- a/docs/components/stopservertoolswhenfinishreasonis.mdx +++ b/docs/components/stopservertoolswhenfinishreasonis.mdx @@ -9,5 +9,5 @@ Stop when the upstream model emits this finish reason (e.g. `length`). | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `reason` | *str* | ✅ | N/A | -| `type` | [components.StopServerToolsWhenFinishReasonIsType](../components/stopservertoolswhenfinishreasonistype.mdx) | ✅ | N/A | \ No newline at end of file +| `reason` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.StopServerToolsWhenFinishReasonIsType](../components/stopservertoolswhenfinishreasonistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenhastoolcall.mdx b/docs/components/stopservertoolswhenhastoolcall.mdx index f5418eaf3..890af332e 100644 --- a/docs/components/stopservertoolswhenhastoolcall.mdx +++ b/docs/components/stopservertoolswhenhastoolcall.mdx @@ -9,5 +9,5 @@ Stop after a tool with this name has been called. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `tool_name` | *str* | ✅ | N/A | -| `type` | [components.StopServerToolsWhenHasToolCallType](../components/stopservertoolswhenhastoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file +| `tool_name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.StopServerToolsWhenHasToolCallType](../components/stopservertoolswhenhastoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenmaxcost.mdx b/docs/components/stopservertoolswhenmaxcost.mdx index 33399e736..11ec52648 100644 --- a/docs/components/stopservertoolswhenmaxcost.mdx +++ b/docs/components/stopservertoolswhenmaxcost.mdx @@ -9,5 +9,5 @@ Stop once cumulative cost across the loop exceeds this dollar threshold. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `max_cost_in_dollars` | *float* | ✅ | N/A | -| `type` | [components.StopServerToolsWhenMaxCostType](../components/stopservertoolswhenmaxcosttype.mdx) | ✅ | N/A | \ No newline at end of file +| `max_cost_in_dollars` | *float* | :heavy_check_mark: | N/A | +| `type` | [components.StopServerToolsWhenMaxCostType](../components/stopservertoolswhenmaxcosttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenmaxtokensused.mdx b/docs/components/stopservertoolswhenmaxtokensused.mdx index e70c236f8..33d4618b4 100644 --- a/docs/components/stopservertoolswhenmaxtokensused.mdx +++ b/docs/components/stopservertoolswhenmaxtokensused.mdx @@ -9,5 +9,5 @@ Stop once cumulative token usage across the loop exceeds this threshold. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `max_tokens` | *int* | ✅ | N/A | -| `type` | [components.StopServerToolsWhenMaxTokensUsedType](../components/stopservertoolswhenmaxtokensusedtype.mdx) | ✅ | N/A | \ No newline at end of file +| `max_tokens` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.StopServerToolsWhenMaxTokensUsedType](../components/stopservertoolswhenmaxtokensusedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenstepcountis.mdx b/docs/components/stopservertoolswhenstepcountis.mdx index d49ce5c1d..0544b66ff 100644 --- a/docs/components/stopservertoolswhenstepcountis.mdx +++ b/docs/components/stopservertoolswhenstepcountis.mdx @@ -9,5 +9,5 @@ Stop after the agent loop has executed this many steps. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `step_count` | *int* | ✅ | N/A | -| `type` | [components.StopServerToolsWhenStepCountIsType](../components/stopservertoolswhenstepcountistype.mdx) | ✅ | N/A | \ No newline at end of file +| `step_count` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.StopServerToolsWhenStepCountIsType](../components/stopservertoolswhenstepcountistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/storedprompttemplate.mdx b/docs/components/storedprompttemplate.mdx index 67f2f9e42..a9461bc3e 100644 --- a/docs/components/storedprompttemplate.mdx +++ b/docs/components/storedprompttemplate.mdx @@ -6,5 +6,5 @@ title: "StoredPromptTemplate" | Field | Type | Required | Description | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | -| `variables` | Dict[str, [components.Variables](../components/variables.mdx)] | ➖ | N/A | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | N/A | +| `variables` | Dict[str, [components.Variables](../components/variables.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/streameventsresponsecompleted.mdx b/docs/components/streameventsresponsecompleted.mdx index c510dfb27..35bdaf313 100644 --- a/docs/components/streameventsresponsecompleted.mdx +++ b/docs/components/streameventsresponsecompleted.mdx @@ -9,6 +9,6 @@ Event emitted when a response has completed successfully | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | ✅ | N/A | | -| `type` | [components.StreamEventsResponseCompletedType](../components/streameventsresponsecompletedtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.StreamEventsResponseCompletedType](../components/streameventsresponsecompletedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/streameventsresponsefailed.mdx b/docs/components/streameventsresponsefailed.mdx index 854bcab46..2fe71e963 100644 --- a/docs/components/streameventsresponsefailed.mdx +++ b/docs/components/streameventsresponsefailed.mdx @@ -9,6 +9,6 @@ Event emitted when a response has failed | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | ✅ | N/A | | -| `type` | [components.StreamEventsResponseFailedType](../components/streameventsresponsefailedtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.StreamEventsResponseFailedType](../components/streameventsresponsefailedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/streameventsresponseincomplete.mdx b/docs/components/streameventsresponseincomplete.mdx index 2e1458b75..0abd1db55 100644 --- a/docs/components/streameventsresponseincomplete.mdx +++ b/docs/components/streameventsresponseincomplete.mdx @@ -9,6 +9,6 @@ Event emitted when a response is incomplete | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | ✅ | N/A | | -| `type` | [components.StreamEventsResponseIncompleteType](../components/streameventsresponseincompletetype.mdx) | ✅ | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.StreamEventsResponseIncompleteType](../components/streameventsresponseincompletetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/streameventsresponseoutputitemadded.mdx b/docs/components/streameventsresponseoutputitemadded.mdx index c74d14f11..8121198a7 100644 --- a/docs/components/streameventsresponseoutputitemadded.mdx +++ b/docs/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](../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"
} | -| `output_index` | *int* | ✅ | N/A | | -| `sequence_number` | *int* | ✅ | N/A | | -| `type` | [components.StreamEventsResponseOutputItemAddedType](../components/streameventsresponseoutputitemaddedtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `item` | [components.OutputItems](../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"
} | +| `output_index` | *int* | :heavy_check_mark: | N/A | | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.StreamEventsResponseOutputItemAddedType](../components/streameventsresponseoutputitemaddedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/streameventsresponseoutputitemdone.mdx b/docs/components/streameventsresponseoutputitemdone.mdx index 19a80220b..5d02fd8ea 100644 --- a/docs/components/streameventsresponseoutputitemdone.mdx +++ b/docs/components/streameventsresponseoutputitemdone.mdx @@ -9,7 +9,7 @@ Event emitted when an output item is complete | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `item` | [components.OutputItems](../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"
} | -| `output_index` | *int* | ✅ | N/A | | -| `sequence_number` | *int* | ✅ | N/A | | -| `type` | [components.StreamEventsResponseOutputItemDoneType](../components/streameventsresponseoutputitemdonetype.mdx) | ✅ | N/A | | \ No newline at end of file +| `item` | [components.OutputItems](../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"
} | +| `output_index` | *int* | :heavy_check_mark: | N/A | | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | | +| `type` | [components.StreamEventsResponseOutputItemDoneType](../components/streameventsresponseoutputitemdonetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/streamlogprob.mdx b/docs/components/streamlogprob.mdx index 1f5198be9..398824645 100644 --- a/docs/components/streamlogprob.mdx +++ b/docs/components/streamlogprob.mdx @@ -9,7 +9,7 @@ Log probability information for a token | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | ➖ | N/A | -| `logprob` | *float* | ✅ | N/A | -| `token` | *str* | ✅ | N/A | -| `top_logprobs` | List[[components.StreamLogprobTopLogprob](../components/streamlogprobtoplogprob.mdx)] | ➖ | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_minus_sign: | N/A | +| `logprob` | *float* | :heavy_check_mark: | N/A | +| `token` | *str* | :heavy_check_mark: | N/A | +| `top_logprobs` | List[[components.StreamLogprobTopLogprob](../components/streamlogprobtoplogprob.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/streamlogprobtoplogprob.mdx b/docs/components/streamlogprobtoplogprob.mdx index d20165881..972fa7f69 100644 --- a/docs/components/streamlogprobtoplogprob.mdx +++ b/docs/components/streamlogprobtoplogprob.mdx @@ -9,6 +9,6 @@ Alternative token with its log probability | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | ➖ | N/A | -| `logprob` | *Optional[float]* | ➖ | N/A | -| `token` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | :heavy_minus_sign: | N/A | +| `logprob` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `token` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/stt.mdx b/docs/components/stt.mdx index b73a789e8..5ebe2d199 100644 --- a/docs/components/stt.mdx +++ b/docs/components/stt.mdx @@ -6,6 +6,6 @@ title: "STT" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/sttentity.mdx b/docs/components/sttentity.mdx index d88efcc75..70d1ffaf4 100644 --- a/docs/components/sttentity.mdx +++ b/docs/components/sttentity.mdx @@ -9,7 +9,7 @@ A detected entity, returned when the provider runs entity detection | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `end_char` | *int* | ✅ | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | -| `start_char` | *int* | ✅ | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | -| `text` | *str* | ✅ | Entity text as it appears in the transcript | | -| `type` | *str* | ✅ | Provider entity type label | name | \ No newline at end of file +| `end_char` | *int* | :heavy_check_mark: | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | +| `start_char` | *int* | :heavy_check_mark: | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | +| `text` | *str* | :heavy_check_mark: | Entity text as it appears in the transcript | | +| `type` | *str* | :heavy_check_mark: | Provider entity type label | name | \ No newline at end of file diff --git a/docs/components/sttinlineinputaudio.mdx b/docs/components/sttinlineinputaudio.mdx index 099d46be9..dfcdc6b10 100644 --- a/docs/components/sttinlineinputaudio.mdx +++ b/docs/components/sttinlineinputaudio.mdx @@ -9,5 +9,5 @@ Inline base64 audio input for speech-to-text | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *str* | ✅ | Base64-encoded audio data (raw bytes, not a data URI) | -| `format_` | *str* | ✅ | 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` | *str* | :heavy_check_mark: | Base64-encoded audio data (raw bytes, not a data URI) | +| `format_` | *str* | :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/components/sttrequest.mdx b/docs/components/sttrequest.mdx index 9dffd6e29..928d5db30 100644 --- a/docs/components/sttrequest.mdx +++ b/docs/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` | *Optional[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 | -| `input_audio` | [components.STTInputAudio](../components/sttinputaudio.mdx) | ✅ | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | -| `keyterms` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | -| `model` | *str* | ✅ | STT model identifier | openai/whisper-large-v3 | -| `provider` | [Optional[components.STTRequestProvider]](../components/sttrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `response_format` | [Optional[components.STTRequestResponseFormat]](../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 | -| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | Sampling temperature for transcription | 0 | -| `timestamp_granularities` | List[[components.STTTimestampGranularity](../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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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` | *Optional[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 | +| `input_audio` | [components.STTInputAudio](../components/sttinputaudio.mdx) | :heavy_check_mark: | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | +| `keyterms` | List[*str*] | :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` | *Optional[str]* | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | +| `model` | *str* | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | +| `provider` | [Optional[components.STTRequestProvider]](../components/sttrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `response_format` | [Optional[components.STTRequestResponseFormat]](../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 | +| `session_id` | *Optional[str]* | :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` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature for transcription | 0 | +| `timestamp_granularities` | List[[components.STTTimestampGranularity](../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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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/components/sttrequestprovider.mdx b/docs/components/sttrequestprovider.mdx index cb144551e..ddc964b62 100644 --- a/docs/components/sttrequestprovider.mdx +++ b/docs/components/sttrequestprovider.mdx @@ -9,6 +9,6 @@ Provider configuration: data policy routing preferences (`zdr`, `data_collection | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data_collection` | [OptionalNullable[components.STTRequestDataCollection]](../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` | [Optional[components.ProviderOptions]](../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[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 +| `data_collection` | [OptionalNullable[components.STTRequestDataCollection]](../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` | [Optional[components.ProviderOptions]](../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[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/components/sttresponse.mdx b/docs/components/sttresponse.mdx index f6d005b67..8cc193265 100644 --- a/docs/components/sttresponse.mdx +++ b/docs/components/sttresponse.mdx @@ -9,13 +9,13 @@ STT response containing transcribed text and optional usage statistics | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `confidence` | *Optional[float]* | ➖ | 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` | *Optional[float]* | ➖ | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | -| `entities` | List[[components.STTEntity](../components/sttentity.mdx)] | ➖ | Detected entities with character offsets into text, present when the provider runs entity detection | | -| `language` | *Optional[str]* | ➖ | Detected or forced language, present when response_format is verbose_json | english | -| `language_confidence` | *Optional[float]* | ➖ | 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` | List[[components.STTSegment](../components/sttsegment.mdx)] | ➖ | Timestamped transcript segments, present when response_format is verbose_json | | -| `task` | *Optional[str]* | ➖ | The task performed, present when response_format is verbose_json | transcribe | -| `text` | *str* | ✅ | 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` | [Optional[components.STTUsage]](../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` | List[[components.STTWord](../components/sttword.mdx)] | ➖ | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file +| `confidence` | *Optional[float]* | :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` | *Optional[float]* | :heavy_minus_sign: | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | +| `entities` | List[[components.STTEntity](../components/sttentity.mdx)] | :heavy_minus_sign: | Detected entities with character offsets into text, present when the provider runs entity detection | | +| `language` | *Optional[str]* | :heavy_minus_sign: | Detected or forced language, present when response_format is verbose_json | english | +| `language_confidence` | *Optional[float]* | :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` | List[[components.STTSegment](../components/sttsegment.mdx)] | :heavy_minus_sign: | Timestamped transcript segments, present when response_format is verbose_json | | +| `task` | *Optional[str]* | :heavy_minus_sign: | The task performed, present when response_format is verbose_json | transcribe | +| `text` | *str* | :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` | [Optional[components.STTUsage]](../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` | List[[components.STTWord](../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/components/sttsegment.mdx b/docs/components/sttsegment.mdx index 26d36a947..dbe1e88ec 100644 --- a/docs/components/sttsegment.mdx +++ b/docs/components/sttsegment.mdx @@ -9,16 +9,16 @@ A timestamped transcript segment, returned when response_format is verbose_json | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `avg_logprob` | *Optional[float]* | ➖ | Average log probability of the segment | | -| `channel` | *Optional[int]* | ➖ | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | -| `compression_ratio` | *Optional[float]* | ➖ | Compression ratio of the segment | | -| `end` | *float* | ✅ | Segment end time in seconds | 3.2 | -| `id` | *int* | ✅ | Segment index within the transcript | 0 | -| `no_speech_prob` | *Optional[float]* | ➖ | Probability the segment contains no speech | | -| `seek` | *Optional[int]* | ➖ | Seek offset of the segment | 0 | -| `speaker` | *Optional[int]* | ➖ | Speaker index for the segment, present when the provider returns diarization data | 0 | -| `speaker_label` | *Optional[str]* | ➖ | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | -| `start` | *float* | ✅ | Segment start time in seconds | 0 | -| `temperature` | *Optional[float]* | ➖ | Temperature used for the segment | | -| `text` | *str* | ✅ | Transcribed text of the segment | Hello there. | -| `tokens` | List[*int*] | ➖ | Token IDs of the segment | | \ No newline at end of file +| `avg_logprob` | *Optional[float]* | :heavy_minus_sign: | Average log probability of the segment | | +| `channel` | *Optional[int]* | :heavy_minus_sign: | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | +| `compression_ratio` | *Optional[float]* | :heavy_minus_sign: | Compression ratio of the segment | | +| `end` | *float* | :heavy_check_mark: | Segment end time in seconds | 3.2 | +| `id` | *int* | :heavy_check_mark: | Segment index within the transcript | 0 | +| `no_speech_prob` | *Optional[float]* | :heavy_minus_sign: | Probability the segment contains no speech | | +| `seek` | *Optional[int]* | :heavy_minus_sign: | Seek offset of the segment | 0 | +| `speaker` | *Optional[int]* | :heavy_minus_sign: | Speaker index for the segment, present when the provider returns diarization data | 0 | +| `speaker_label` | *Optional[str]* | :heavy_minus_sign: | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | +| `start` | *float* | :heavy_check_mark: | Segment start time in seconds | 0 | +| `temperature` | *Optional[float]* | :heavy_minus_sign: | Temperature used for the segment | | +| `text` | *str* | :heavy_check_mark: | Transcribed text of the segment | Hello there. | +| `tokens` | List[*int*] | :heavy_minus_sign: | Token IDs of the segment | | \ No newline at end of file diff --git a/docs/components/stturlinputaudio.mdx b/docs/components/stturlinputaudio.mdx index 1162f536a..bc1eb6aef 100644 --- a/docs/components/stturlinputaudio.mdx +++ b/docs/components/stturlinputaudio.mdx @@ -9,5 +9,5 @@ Audio input fetched by the provider from a URL | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format_` | *Optional[str]* | ➖ | Audio format of the file at the URL. Defaults to the extension of the URL path; required when the path has no extension. | -| `url` | *str* | ✅ | 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_` | *Optional[str]* | :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` | *str* | :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/components/sttusage.mdx b/docs/components/sttusage.mdx index 0ef1266dd..f0b56839c 100644 --- a/docs/components/sttusage.mdx +++ b/docs/components/sttusage.mdx @@ -9,8 +9,8 @@ Aggregated usage statistics for the request | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `cost` | *Optional[float]* | ➖ | Total cost of the request in USD | 0.000508 | -| `input_tokens` | *Optional[int]* | ➖ | Number of input tokens billed for this request | 83 | -| `output_tokens` | *Optional[int]* | ➖ | Number of output tokens generated | 30 | -| `seconds` | *Optional[float]* | ➖ | Duration of the input audio in seconds | 9.2 | -| `total_tokens` | *Optional[int]* | ➖ | Total number of tokens used (input + output) | 113 | \ No newline at end of file +| `cost` | *Optional[float]* | :heavy_minus_sign: | Total cost of the request in USD | 0.000508 | +| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of input tokens billed for this request | 83 | +| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of output tokens generated | 30 | +| `seconds` | *Optional[float]* | :heavy_minus_sign: | Duration of the input audio in seconds | 9.2 | +| `total_tokens` | *Optional[int]* | :heavy_minus_sign: | Total number of tokens used (input + output) | 113 | \ No newline at end of file diff --git a/docs/components/sttword.mdx b/docs/components/sttword.mdx index 430df270f..48e877265 100644 --- a/docs/components/sttword.mdx +++ b/docs/components/sttword.mdx @@ -9,11 +9,11 @@ A timestamped word, returned when the provider includes word-level timestamps | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `channel` | *Optional[int]* | ➖ | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | -| `confidence` | *Optional[float]* | ➖ | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | -| `end` | *float* | ✅ | Word end time in seconds | 0.4 | -| `speaker` | *Optional[int]* | ➖ | Speaker index for the word, present when the provider returns diarization data | 0 | -| `speaker_label` | *Optional[str]* | ➖ | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | -| `start` | *float* | ✅ | Word start time in seconds | 0 | -| `type` | [Optional[components.STTWordType]](../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` | *str* | ✅ | The transcribed word, or the event tag such as "(laughter)" when type is audio_event | Hello | \ No newline at end of file +| `channel` | *Optional[int]* | :heavy_minus_sign: | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | +| `confidence` | *Optional[float]* | :heavy_minus_sign: | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | +| `end` | *float* | :heavy_check_mark: | Word end time in seconds | 0.4 | +| `speaker` | *Optional[int]* | :heavy_minus_sign: | Speaker index for the word, present when the provider returns diarization data | 0 | +| `speaker_label` | *Optional[str]* | :heavy_minus_sign: | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | +| `start` | *float* | :heavy_check_mark: | Word start time in seconds | 0 | +| `type` | [Optional[components.STTWordType]](../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` | *str* | :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/components/subagentnestedtool.mdx b/docs/components/subagentnestedtool.mdx index 67e7d558e..957462250 100644 --- a/docs/components/subagentnestedtool.mdx +++ b/docs/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` | Dict[str, *Any*] | ➖ | N/A | | -| `type` | *str* | ✅ | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file +| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `type` | *str* | :heavy_check_mark: | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file diff --git a/docs/components/subagentreasoning.mdx b/docs/components/subagentreasoning.mdx index 129b89f29..c1d3baea5 100644 --- a/docs/components/subagentreasoning.mdx +++ b/docs/components/subagentreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the subagent call. Use this to control reas | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `effort` | [Optional[components.SubagentReasoningEffort]](../components/subagentreasoningeffort.mdx) | ➖ | Reasoning effort level for the subagent call. | -| `max_tokens` | *Optional[int]* | ➖ | 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` | [Optional[components.SubagentReasoningEffort]](../components/subagentreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the subagent call. | +| `max_tokens` | *Optional[int]* | :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/components/subagentservertoolconfig.mdx b/docs/components/subagentservertoolconfig.mdx index c314c4317..3e6825bc8 100644 --- a/docs/components/subagentservertoolconfig.mdx +++ b/docs/components/subagentservertoolconfig.mdx @@ -9,13 +9,13 @@ Configuration for one openrouter:subagent server tool entry. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `inherit_functions` | *Optional[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 | -| `inherited_function_names` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | 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. | -| `max_completion_tokens` | *Optional[int]* | ➖ | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | -| `max_tool_calls` | *Optional[int]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.SubagentReasoning]](../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` | *Optional[float]* | ➖ | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | -| `tools` | List[[components.SubagentNestedTool](../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 +| `inherit_functions` | *Optional[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 | +| `inherited_function_names` | List[*str*] | :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` | *Optional[str]* | :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. | +| `max_completion_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | +| `max_tool_calls` | *Optional[int]* | :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` | *Optional[str]* | :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` | *Optional[str]* | :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` | [Optional[components.SubagentReasoning]](../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` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | +| `tools` | List[[components.SubagentNestedTool](../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/components/subagentservertoolopenrouter.mdx b/docs/components/subagentservertoolopenrouter.mdx index 86cc77a9a..3b1eb0a63 100644 --- a/docs/components/subagentservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.SubagentServerToolConfig]](../components/subagentservertoolconfig.mdx) | ➖ | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | -| `type` | [components.SubagentServerToolOpenRouterType](../components/subagentservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.SubagentServerToolConfig]](../components/subagentservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | +| `type` | [components.SubagentServerToolOpenRouterType](../components/subagentservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/submitgenerationfeedbackrequest.mdx b/docs/components/submitgenerationfeedbackrequest.mdx index 80f32cd22..4ac73ca3e 100644 --- a/docs/components/submitgenerationfeedbackrequest.mdx +++ b/docs/components/submitgenerationfeedbackrequest.mdx @@ -9,6 +9,6 @@ Structured feedback about a specific generation | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `category` | [components.SubmitGenerationFeedbackRequestCategory](../components/submitgenerationfeedbackrequestcategory.mdx) | ✅ | The category of feedback being reported | incorrect_response | -| `comment` | *Optional[str]* | ➖ | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | -| `generation_id` | *str* | ✅ | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file +| `category` | [components.SubmitGenerationFeedbackRequestCategory](../components/submitgenerationfeedbackrequestcategory.mdx) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | +| `comment` | *Optional[str]* | :heavy_minus_sign: | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | +| `generation_id` | *str* | :heavy_check_mark: | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file diff --git a/docs/components/submitgenerationfeedbackresponse.mdx b/docs/components/submitgenerationfeedbackresponse.mdx index 5f761246a..ba546e044 100644 --- a/docs/components/submitgenerationfeedbackresponse.mdx +++ b/docs/components/submitgenerationfeedbackresponse.mdx @@ -9,4 +9,4 @@ Confirmation that the feedback was recorded | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `data` | [components.SubmitGenerationFeedbackResponseData](../components/submitgenerationfeedbackresponsedata.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.SubmitGenerationFeedbackResponseData](../components/submitgenerationfeedbackresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/submitgenerationfeedbackresponsedata.mdx b/docs/components/submitgenerationfeedbackresponsedata.mdx index 144ea4164..2b6ccfe57 100644 --- a/docs/components/submitgenerationfeedbackresponsedata.mdx +++ b/docs/components/submitgenerationfeedbackresponsedata.mdx @@ -6,4 +6,4 @@ title: "SubmitGenerationFeedbackResponseData" | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `success` | *Literal[True]* | ✅ | Whether the feedback was recorded | true | \ No newline at end of file +| `success` | *Literal[True]* | :heavy_check_mark: | Whether the feedback was recorded | true | \ No newline at end of file diff --git a/docs/components/suspendinternresponse.mdx b/docs/components/suspendinternresponse.mdx index 8af1f9d2c..7a513bd20 100644 --- a/docs/components/suspendinternresponse.mdx +++ b/docs/components/suspendinternresponse.mdx @@ -6,4 +6,4 @@ title: "SuspendInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `suspended` | *Literal[True]* | ✅ | N/A | \ No newline at end of file +| `suspended` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/switchyardrouterplugin.mdx b/docs/components/switchyardrouterplugin.mdx index 468116091..7a3a09ce0 100644 --- a/docs/components/switchyardrouterplugin.mdx +++ b/docs/components/switchyardrouterplugin.mdx @@ -6,6 +6,6 @@ title: "SwitchyardRouterPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `algorithm` | [Optional[components.Algorithm]](../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](../components/switchyardrouterpluginid.mdx) | ✅ | N/A | | -| `judge_model` | *Optional[str]* | ➖ | 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` | [Optional[components.Algorithm]](../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](../components/switchyardrouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `judge_model` | *Optional[str]* | :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/components/taskbudget.mdx b/docs/components/taskbudget.mdx index 676bd423e..c98814d6f 100644 --- a/docs/components/taskbudget.mdx +++ b/docs/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[int]* | ➖ | N/A | -| `total` | *int* | ✅ | N/A | -| `type` | [components.TypeTokens](../components/typetokens.mdx) | ✅ | N/A | \ No newline at end of file +| `remaining` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | +| `total` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.TypeTokens](../components/typetokens.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/taskclassificationitem.mdx b/docs/components/taskclassificationitem.mdx index 9aef28799..905d90909 100644 --- a/docs/components/taskclassificationitem.mdx +++ b/docs/components/taskclassificationitem.mdx @@ -6,11 +6,11 @@ title: "TaskClassificationItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `category_token_share` | *float* | ✅ | 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 | -| `category_usage_share` | *float* | ✅ | 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 | -| `display_name` | *str* | ✅ | Human-readable label for the classification. | Code Generation | -| `macro_category` | *str* | ✅ | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | -| `models` | List[[components.TaskClassificationModel](../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` | *str* | ✅ | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | -| `token_share` | *float* | ✅ | 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 | -| `usage_share` | *float* | ✅ | 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 +| `category_token_share` | *float* | :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 | +| `category_usage_share` | *float* | :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 | +| `display_name` | *str* | :heavy_check_mark: | Human-readable label for the classification. | Code Generation | +| `macro_category` | *str* | :heavy_check_mark: | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | +| `models` | List[[components.TaskClassificationModel](../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` | *str* | :heavy_check_mark: | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | +| `token_share` | *float* | :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 | +| `usage_share` | *float* | :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/components/taskclassificationmacrocategory.mdx b/docs/components/taskclassificationmacrocategory.mdx index cebaae8e5..1f45abf4c 100644 --- a/docs/components/taskclassificationmacrocategory.mdx +++ b/docs/components/taskclassificationmacrocategory.mdx @@ -6,7 +6,7 @@ title: "TaskClassificationMacroCategory" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *str* | ✅ | Macro-category identifier. | code | -| `label` | *str* | ✅ | Human-readable label for the macro-category. | Code | -| `token_share` | *float* | ✅ | Combined token share of all classifications in this macro-category (0–1). | 0.52 | -| `usage_share` | *float* | ✅ | Combined usage share of all classifications in this macro-category (0–1). | 0.45 | \ No newline at end of file +| `key` | *str* | :heavy_check_mark: | Macro-category identifier. | code | +| `label` | *str* | :heavy_check_mark: | Human-readable label for the macro-category. | Code | +| `token_share` | *float* | :heavy_check_mark: | Combined token share of all classifications in this macro-category (0–1). | 0.52 | +| `usage_share` | *float* | :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/components/taskclassificationmodel.mdx b/docs/components/taskclassificationmodel.mdx index 14ebe1063..137c9bc4a 100644 --- a/docs/components/taskclassificationmodel.mdx +++ b/docs/components/taskclassificationmodel.mdx @@ -6,6 +6,6 @@ title: "TaskClassificationModel" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | Model identifier (permaslug). | openai/gpt-4.1-mini | -| `tag_token_share` | *float* | ✅ | 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 | -| `tag_usage_share` | *float* | ✅ | 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` | *str* | :heavy_check_mark: | Model identifier (permaslug). | openai/gpt-4.1-mini | +| `tag_token_share` | *float* | :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 | +| `tag_usage_share` | *float* | :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/components/taskclassificationresponse.mdx b/docs/components/taskclassificationresponse.mdx index bec951d2c..40e0bc7f5 100644 --- a/docs/components/taskclassificationresponse.mdx +++ b/docs/components/taskclassificationresponse.mdx @@ -6,4 +6,4 @@ title: "TaskClassificationResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `data` | [components.TaskClassificationResponseData](../components/taskclassificationresponsedata.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.TaskClassificationResponseData](../components/taskclassificationresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/taskclassificationresponsedata.mdx b/docs/components/taskclassificationresponsedata.mdx index 53a1a3889..a22f20ac9 100644 --- a/docs/components/taskclassificationresponsedata.mdx +++ b/docs/components/taskclassificationresponsedata.mdx @@ -6,7 +6,7 @@ title: "TaskClassificationResponseData" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `as_of` | *str* | ✅ | 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` | List[[components.TaskClassificationItem](../components/taskclassificationitem.mdx)] | ✅ | Per-task classification market-share data, sorted by usage_share descending. | | -| `macro_categories` | List[[components.TaskClassificationMacroCategory](../components/taskclassificationmacrocategory.mdx)] | ✅ | Aggregate market-share data per macro-category (code, data, agent, general). | | -| `window_days` | *int* | ✅ | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file +| `as_of` | *str* | :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` | List[[components.TaskClassificationItem](../components/taskclassificationitem.mdx)] | :heavy_check_mark: | Per-task classification market-share data, sorted by usage_share descending. | | +| `macro_categories` | List[[components.TaskClassificationMacroCategory](../components/taskclassificationmacrocategory.mdx)] | :heavy_check_mark: | Aggregate market-share data per macro-category (code, data, agent, general). | | +| `window_days` | *int* | :heavy_check_mark: | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file diff --git a/docs/components/textdeltaevent.mdx b/docs/components/textdeltaevent.mdx index e3b3ecec1..8214536b8 100644 --- a/docs/components/textdeltaevent.mdx +++ b/docs/components/textdeltaevent.mdx @@ -9,10 +9,10 @@ Event emitted when a text delta is streamed | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `content_index` | *int* | ✅ | N/A | -| `delta` | *str* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `logprobs` | List[[components.StreamLogprob](../components/streamlogprob.mdx)] | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.TextDeltaEventType](../components/textdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content_index` | *int* | :heavy_check_mark: | N/A | +| `delta` | *str* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `logprobs` | List[[components.StreamLogprob](../components/streamlogprob.mdx)] | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.TextDeltaEventType](../components/textdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/textdoneevent.mdx b/docs/components/textdoneevent.mdx index 54ae977e0..d2d166000 100644 --- a/docs/components/textdoneevent.mdx +++ b/docs/components/textdoneevent.mdx @@ -9,10 +9,10 @@ Event emitted when text streaming is complete | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content_index` | *int* | ✅ | N/A | -| `item_id` | *str* | ✅ | N/A | -| `logprobs` | List[[components.StreamLogprob](../components/streamlogprob.mdx)] | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `text` | *str* | ✅ | N/A | -| `type` | [components.TextDoneEventType](../components/textdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `content_index` | *int* | :heavy_check_mark: | N/A | +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `logprobs` | List[[components.StreamLogprob](../components/streamlogprob.mdx)] | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.TextDoneEventType](../components/textdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/textextendedconfig.mdx b/docs/components/textextendedconfig.mdx index c211e4a9f..04c08c1d7 100644 --- a/docs/components/textextendedconfig.mdx +++ b/docs/components/textextendedconfig.mdx @@ -9,5 +9,5 @@ Text output configuration including format and verbosity | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `format_` | [Optional[components.Formats]](../components/formats.mdx) | ➖ | Text response format configuration | \{
"type": "text"
} | -| `verbosity` | [OptionalNullable[components.Verbosity]](../components/verbosity.mdx) | ➖ | N/A | | \ No newline at end of file +| `format_` | [Optional[components.Formats]](../components/formats.mdx) | :heavy_minus_sign: | Text response format configuration | \{
"type": "text"
} | +| `verbosity` | [OptionalNullable[components.Verbosity]](../components/verbosity.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/textgeneration.mdx b/docs/components/textgeneration.mdx index 5450891f9..83129fca0 100644 --- a/docs/components/textgeneration.mdx +++ b/docs/components/textgeneration.mdx @@ -6,6 +6,6 @@ title: "TextGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/thinkingadaptive.mdx b/docs/components/thinkingadaptive.mdx index 220914c44..eea8c5cd1 100644 --- a/docs/components/thinkingadaptive.mdx +++ b/docs/components/thinkingadaptive.mdx @@ -6,6 +6,6 @@ title: "ThinkingAdaptive" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `block_binding` | [OptionalNullable[components.AnthropicThinkingBlockBinding]](../components/anthropicthinkingblockbinding.mdx) | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.mdx) | ➖ | N/A | summarized | -| `type` | [components.TypeAdaptive](../components/typeadaptive.mdx) | ✅ | N/A | | \ No newline at end of file +| `block_binding` | [OptionalNullable[components.AnthropicThinkingBlockBinding]](../components/anthropicthinkingblockbinding.mdx) | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.mdx) | :heavy_minus_sign: | N/A | summarized | +| `type` | [components.TypeAdaptive](../components/typeadaptive.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/thinkingbetweentools.mdx b/docs/components/thinkingbetweentools.mdx index c84e7387f..52bebea40 100644 --- a/docs/components/thinkingbetweentools.mdx +++ b/docs/components/thinkingbetweentools.mdx @@ -6,4 +6,4 @@ title: "ThinkingBetweenTools" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `type` | [components.TypeBetweenTools](../components/typebetweentools.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.TypeBetweenTools](../components/typebetweentools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/thinkingdisabled.mdx b/docs/components/thinkingdisabled.mdx index 6730aabd4..5da5da387 100644 --- a/docs/components/thinkingdisabled.mdx +++ b/docs/components/thinkingdisabled.mdx @@ -6,4 +6,4 @@ title: "ThinkingDisabled" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [components.ThinkingTypeDisabled](../components/thinkingtypedisabled.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.ThinkingTypeDisabled](../components/thinkingtypedisabled.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/thinkingenabled.mdx b/docs/components/thinkingenabled.mdx index d5d30a46b..8a1bc3e1b 100644 --- a/docs/components/thinkingenabled.mdx +++ b/docs/components/thinkingenabled.mdx @@ -6,7 +6,7 @@ title: "ThinkingEnabled" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `block_binding` | [OptionalNullable[components.AnthropicThinkingBlockBinding]](../components/anthropicthinkingblockbinding.mdx) | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `budget_tokens` | *int* | ✅ | N/A | | -| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.mdx) | ➖ | N/A | summarized | -| `type` | [components.TypeEnabled](../components/typeenabled.mdx) | ✅ | N/A | | \ No newline at end of file +| `block_binding` | [OptionalNullable[components.AnthropicThinkingBlockBinding]](../components/anthropicthinkingblockbinding.mdx) | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `budget_tokens` | *int* | :heavy_check_mark: | N/A | | +| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.mdx) | :heavy_minus_sign: | N/A | summarized | +| `type` | [components.TypeEnabled](../components/typeenabled.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/tokenexchangerequest.mdx b/docs/components/tokenexchangerequest.mdx index 59182ed6a..a086ed565 100644 --- a/docs/components/tokenexchangerequest.mdx +++ b/docs/components/tokenexchangerequest.mdx @@ -9,9 +9,9 @@ RFC 8693 token exchange request body (application/x-www-form-urlencoded). | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `federation_policy_id` | *str* | ✅ | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | -| `grant_type` | [components.GrantType](../components/granttype.mdx) | ✅ | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | -| `requested_token_type` | [Optional[components.RequestedTokenType]](../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` | [Optional[components.TokenExchangeRequestScope]](../components/tokenexchangerequestscope.mdx) | ➖ | Optional; only `inference` is available. | inference | -| `subject_token` | *str* | ✅ | The JWT issued by your identity provider. | \ | -| `subject_token_type` | [components.SubjectTokenType](../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 +| `federation_policy_id` | *str* | :heavy_check_mark: | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | +| `grant_type` | [components.GrantType](../components/granttype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | +| `requested_token_type` | [Optional[components.RequestedTokenType]](../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` | [Optional[components.TokenExchangeRequestScope]](../components/tokenexchangerequestscope.mdx) | :heavy_minus_sign: | Optional; only `inference` is available. | inference | +| `subject_token` | *str* | :heavy_check_mark: | The JWT issued by your identity provider. | \ | +| `subject_token_type` | [components.SubjectTokenType](../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/components/tokenexchangeresponse.mdx b/docs/components/tokenexchangeresponse.mdx index 9078e209e..c3a8de52d 100644 --- a/docs/components/tokenexchangeresponse.mdx +++ b/docs/components/tokenexchangeresponse.mdx @@ -9,8 +9,8 @@ RFC 8693 token exchange response. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `access_token` | *str* | ✅ | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | -| `expires_in` | *int* | ✅ | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | -| `issued_token_type` | [components.IssuedTokenType](../components/issuedtokentype.mdx) | ✅ | N/A | urn:ietf:params:oauth:token-type:access_token | -| `scope` | *str* | ✅ | N/A | inference | -| `token_type` | [components.TokenType](../components/tokentype.mdx) | ✅ | N/A | Bearer | \ No newline at end of file +| `access_token` | *str* | :heavy_check_mark: | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | +| `expires_in` | *int* | :heavy_check_mark: | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | +| `issued_token_type` | [components.IssuedTokenType](../components/issuedtokentype.mdx) | :heavy_check_mark: | N/A | urn:ietf:params:oauth:token-type:access_token | +| `scope` | *str* | :heavy_check_mark: | N/A | inference | +| `token_type` | [components.TokenType](../components/tokentype.mdx) | :heavy_check_mark: | N/A | Bearer | \ No newline at end of file diff --git a/docs/components/tooladvisor20260301.mdx b/docs/components/tooladvisor20260301.mdx index 76b180e20..cf0c0f91f 100644 --- a/docs/components/tooladvisor20260301.mdx +++ b/docs/components/tooladvisor20260301.mdx @@ -6,11 +6,11 @@ title: "ToolAdvisor20260301" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | ➖ | N/A | [
"direct"
] | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.mdx) | ➖ | N/A | \{
"type": "ephemeral"
} | -| `defer_loading` | *Optional[bool]* | ➖ | N/A | | -| `max_uses` | *Optional[int]* | ➖ | N/A | | -| `model` | *str* | ✅ | N/A | | -| `name` | [components.NameAdvisor](../components/nameadvisor.mdx) | ✅ | N/A | | -| `type` | [components.TypeAdvisor20260301](../components/typeadvisor20260301.mdx) | ✅ | N/A | | \ No newline at end of file +| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | :heavy_minus_sign: | N/A | [
"direct"
] | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | N/A | \{
"type": "ephemeral"
} | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `max_uses` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `name` | [components.NameAdvisor](../components/nameadvisor.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.TypeAdvisor20260301](../components/typeadvisor20260301.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/toolbash20250124.mdx b/docs/components/toolbash20250124.mdx index 222b4ee4d..d3a3ea6cf 100644 --- a/docs/components/toolbash20250124.mdx +++ b/docs/components/toolbash20250124.mdx @@ -6,6 +6,6 @@ title: "ToolBash20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/namebash.mdx) | ✅ | N/A | | -| `type` | [components.TypeBash20250124](../components/typebash20250124.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/namebash.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.TypeBash20250124](../components/typebash20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/toolcall.mdx b/docs/components/toolcall.mdx index 137291c48..c5f4d3277 100644 --- a/docs/components/toolcall.mdx +++ b/docs/components/toolcall.mdx @@ -6,7 +6,7 @@ title: "ToolCall" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `function` | [components.BatchObjectFunction](../components/batchobjectfunction.mdx) | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `index` | *int* | ✅ | N/A | -| `type` | [components.ChoiceTypeFunction](../components/choicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file +| `function` | [components.BatchObjectFunction](../components/batchobjectfunction.mdx) | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `index` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.ChoiceTypeFunction](../components/choicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/toolchoiceallowed.mdx b/docs/components/toolchoiceallowed.mdx index 364bd91bf..4e85322c7 100644 --- a/docs/components/toolchoiceallowed.mdx +++ b/docs/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](../components/mode.mdx) | ✅ | N/A | -| `tools` | List[Dict[str, *Any*]] | ✅ | N/A | -| `type` | [components.ToolChoiceAllowedType](../components/toolchoiceallowedtype.mdx) | ✅ | N/A | \ No newline at end of file +| `mode` | [components.Mode](../components/mode.mdx) | :heavy_check_mark: | N/A | +| `tools` | List[Dict[str, *Any*]] | :heavy_check_mark: | N/A | +| `type` | [components.ToolChoiceAllowedType](../components/toolchoiceallowedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/toolchoiceany.mdx b/docs/components/toolchoiceany.mdx index 4909e4598..444b70155 100644 --- a/docs/components/toolchoiceany.mdx +++ b/docs/components/toolchoiceany.mdx @@ -6,5 +6,5 @@ title: "ToolChoiceAny" | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `disable_parallel_tool_use` | *Optional[bool]* | ➖ | N/A | -| `type` | [components.TypeAny](../components/typeany.mdx) | ✅ | N/A | \ No newline at end of file +| `disable_parallel_tool_use` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [components.TypeAny](../components/typeany.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/toolchoiceauto.mdx b/docs/components/toolchoiceauto.mdx index 9bf6aa9d4..8759b2ff5 100644 --- a/docs/components/toolchoiceauto.mdx +++ b/docs/components/toolchoiceauto.mdx @@ -6,5 +6,5 @@ title: "ToolChoiceAuto" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `disable_parallel_tool_use` | *Optional[bool]* | ➖ | N/A | -| `type` | [components.ToolChoiceTypeAuto](../components/toolchoicetypeauto.mdx) | ✅ | N/A | \ No newline at end of file +| `disable_parallel_tool_use` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [components.ToolChoiceTypeAuto](../components/toolchoicetypeauto.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/toolchoicenone.mdx b/docs/components/toolchoicenone.mdx index 829a82ad3..a042d8988 100644 --- a/docs/components/toolchoicenone.mdx +++ b/docs/components/toolchoicenone.mdx @@ -6,4 +6,4 @@ title: "ToolChoiceNone" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | [components.TypeNone](../components/typenone.mdx) | ✅ | N/A | \ No newline at end of file +| `type` | [components.TypeNone](../components/typenone.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/toolchoicesupport.mdx b/docs/components/toolchoicesupport.mdx index 8f260951c..9b95b3df7 100644 --- a/docs/components/toolchoicesupport.mdx +++ b/docs/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/components/toolchoicetool.mdx b/docs/components/toolchoicetool.mdx index 0e63411c4..08139fd78 100644 --- a/docs/components/toolchoicetool.mdx +++ b/docs/components/toolchoicetool.mdx @@ -6,6 +6,6 @@ title: "ToolChoiceTool" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `disable_parallel_tool_use` | *Optional[bool]* | ➖ | N/A | -| `name` | *str* | ✅ | N/A | -| `type` | [components.TypeTool](../components/typetool.mdx) | ✅ | N/A | \ No newline at end of file +| `disable_parallel_tool_use` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.TypeTool](../components/typetool.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/toolcustom.mdx b/docs/components/toolcustom.mdx index 58127178b..a4ed39817 100644 --- a/docs/components/toolcustom.mdx +++ b/docs/components/toolcustom.mdx @@ -6,10 +6,10 @@ title: "ToolCustom" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `defer_loading` | *Optional[bool]* | ➖ | N/A | | -| `description` | *Optional[str]* | ➖ | N/A | | -| `input_schema` | [components.InputSchema](../components/inputschema.mdx) | ✅ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `strict` | *Optional[bool]* | ➖ | N/A | | -| `type` | [Optional[components.ToolTypeCustom]](../components/tooltypecustom.mdx) | ➖ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `input_schema` | [components.InputSchema](../components/inputschema.mdx) | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `strict` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[components.ToolTypeCustom]](../components/tooltypecustom.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/toolsearchcallitem.mdx b/docs/components/toolsearchcallitem.mdx index b72b5f6c8..470d130f0 100644 --- a/docs/components/toolsearchcallitem.mdx +++ b/docs/components/toolsearchcallitem.mdx @@ -9,9 +9,9 @@ A tool search call the client executed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `arguments` | *Optional[Any]* | ➖ | N/A | -| `call_id` | *str* | ✅ | N/A | -| `execution` | [components.ToolSearchCallItemExecution](../components/toolsearchcallitemexecution.mdx) | ✅ | N/A | -| `id` | *OptionalNullable[str]* | ➖ | N/A | -| `status` | [OptionalNullable[components.ToolSearchCallItemStatus]](../components/toolsearchcallitemstatus.mdx) | ➖ | N/A | -| `type` | [components.ToolSearchCallItemType](../components/toolsearchcallitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `arguments` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `call_id` | *str* | :heavy_check_mark: | N/A | +| `execution` | [components.ToolSearchCallItemExecution](../components/toolsearchcallitemexecution.mdx) | :heavy_check_mark: | N/A | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `status` | [OptionalNullable[components.ToolSearchCallItemStatus]](../components/toolsearchcallitemstatus.mdx) | :heavy_minus_sign: | N/A | +| `type` | [components.ToolSearchCallItemType](../components/toolsearchcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/toolsearchoutputitem.mdx b/docs/components/toolsearchoutputitem.mdx index 1c1e5aa84..a5d1dd6c7 100644 --- a/docs/components/toolsearchoutputitem.mdx +++ b/docs/components/toolsearchoutputitem.mdx @@ -9,9 +9,9 @@ The tools a client-executed tool search loaded | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `call_id` | *str* | ✅ | N/A | -| `execution` | [components.ToolSearchOutputItemExecution](../components/toolsearchoutputitemexecution.mdx) | ✅ | N/A | -| `id` | *OptionalNullable[str]* | ➖ | N/A | -| `status` | [OptionalNullable[components.ToolSearchOutputItemStatus]](../components/toolsearchoutputitemstatus.mdx) | ➖ | N/A | -| `tools` | List[[components.ToolSearchOutputItemToolUnion](../components/toolsearchoutputitemtoolunion.mdx)] | ✅ | N/A | -| `type` | [components.TypeToolSearchOutput](../components/typetoolsearchoutput.mdx) | ✅ | N/A | \ No newline at end of file +| `call_id` | *str* | :heavy_check_mark: | N/A | +| `execution` | [components.ToolSearchOutputItemExecution](../components/toolsearchoutputitemexecution.mdx) | :heavy_check_mark: | N/A | +| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `status` | [OptionalNullable[components.ToolSearchOutputItemStatus]](../components/toolsearchoutputitemstatus.mdx) | :heavy_minus_sign: | N/A | +| `tools` | List[[components.ToolSearchOutputItemToolUnion](../components/toolsearchoutputitemtoolunion.mdx)] | :heavy_check_mark: | N/A | +| `type` | [components.TypeToolSearchOutput](../components/typetoolsearchoutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/toolsearchoutputitemtool.mdx b/docs/components/toolsearchoutputitemtool.mdx index 4af6be7b4..da5087fa6 100644 --- a/docs/components/toolsearchoutputitemtool.mdx +++ b/docs/components/toolsearchoutputitemtool.mdx @@ -6,5 +6,5 @@ title: "ToolSearchOutputItemTool" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | ✅ | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `type` | *str* | :heavy_check_mark: | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/toolsearchoutputitemtoolfunction.mdx b/docs/components/toolsearchoutputitemtoolfunction.mdx index 05cd0d061..49ff0552f 100644 --- a/docs/components/toolsearchoutputitemtoolfunction.mdx +++ b/docs/components/toolsearchoutputitemtoolfunction.mdx @@ -9,12 +9,12 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | ➖ | N/A | | -| `name` | *str* | ✅ | N/A | | -| `parameters` | Dict[str, *Any*] | ✅ | N/A | | -| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | -| `type` | [components.ToolSearchOutputItemTypeFunction](../components/toolsearchoutputitemtypefunction.mdx) | ✅ | N/A | | -| `allowed_callers` | List[[components.ToolSearchOutputItemAllowedCaller](../components/toolsearchoutputitemallowedcaller.mdx)] | ➖ | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | -| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | \ No newline at end of file +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `parameters` | Dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `type` | [components.ToolSearchOutputItemTypeFunction](../components/toolsearchoutputitemtypefunction.mdx) | :heavy_check_mark: | N/A | | +| `allowed_callers` | List[[components.ToolSearchOutputItemAllowedCaller](../components/toolsearchoutputitemallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | +| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/components/toolsearchservertool.mdx b/docs/components/toolsearchservertool.mdx index 7924f0021..4882b510c 100644 --- a/docs/components/toolsearchservertool.mdx +++ b/docs/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` | [Optional[components.ToolSearchServerToolConfig]](../components/toolsearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | -| `type` | [components.ToolSearchServerToolType](../components/toolsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.ToolSearchServerToolConfig]](../components/toolsearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | +| `type` | [components.ToolSearchServerToolType](../components/toolsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/toolsearchservertoolconfig.mdx b/docs/components/toolsearchservertoolconfig.mdx index 4aa6b7643..f6ebf7634 100644 --- a/docs/components/toolsearchservertoolconfig.mdx +++ b/docs/components/toolsearchservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:tool_search server tool | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `max_results` | *Optional[int]* | ➖ | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file +| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file diff --git a/docs/components/tooltexteditor20250124.mdx b/docs/components/tooltexteditor20250124.mdx index d12936170..a7f1a2731 100644 --- a/docs/components/tooltexteditor20250124.mdx +++ b/docs/components/tooltexteditor20250124.mdx @@ -6,6 +6,6 @@ title: "ToolTextEditor20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/namestrreplaceeditor.mdx) | ✅ | N/A | | -| `type` | [components.TypeTextEditor20250124](../components/typetexteditor20250124.mdx) | ✅ | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/namestrreplaceeditor.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.TypeTextEditor20250124](../components/typetexteditor20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/toolwebsearch20250305.mdx b/docs/components/toolwebsearch20250305.mdx index b302ea6ff..36a096412 100644 --- a/docs/components/toolwebsearch20250305.mdx +++ b/docs/components/toolwebsearch20250305.mdx @@ -6,10 +6,10 @@ title: "ToolWebSearch20250305" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_domains` | List[*str*] | ➖ | N/A | | -| `blocked_domains` | List[*str*] | ➖ | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `max_uses` | *OptionalNullable[int]* | ➖ | N/A | | -| `name` | [components.NameWebSearch1](../components/namewebsearch1.mdx) | ✅ | N/A | | -| `type` | [components.TypeWebSearch20250305](../components/typewebsearch20250305.mdx) | ✅ | N/A | | -| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../components/anthropicwebsearchtooluserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | | +| `blocked_domains` | List[*str*] | :heavy_minus_sign: | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `max_uses` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `name` | [components.NameWebSearch1](../components/namewebsearch1.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.TypeWebSearch20250305](../components/typewebsearch20250305.mdx) | :heavy_check_mark: | N/A | | +| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../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/components/toolwebsearch20260209.mdx b/docs/components/toolwebsearch20260209.mdx index 735d1d2e2..062b3155e 100644 --- a/docs/components/toolwebsearch20260209.mdx +++ b/docs/components/toolwebsearch20260209.mdx @@ -6,11 +6,11 @@ title: "ToolWebSearch20260209" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | ➖ | N/A | [
"direct"
] | -| `allowed_domains` | List[*str*] | ➖ | N/A | | -| `blocked_domains` | List[*str*] | ➖ | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `max_uses` | *OptionalNullable[int]* | ➖ | N/A | | -| `name` | [components.NameWebSearch2](../components/namewebsearch2.mdx) | ✅ | N/A | | -| `type` | [components.TypeWebSearch20260209](../components/typewebsearch20260209.mdx) | ✅ | N/A | | -| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../components/anthropicwebsearchtooluserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | :heavy_minus_sign: | N/A | [
"direct"
] | +| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | | +| `blocked_domains` | List[*str*] | :heavy_minus_sign: | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `max_uses` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `name` | [components.NameWebSearch2](../components/namewebsearch2.mdx) | :heavy_check_mark: | N/A | | +| `type` | [components.TypeWebSearch20260209](../components/typewebsearch20260209.mdx) | :heavy_check_mark: | N/A | | +| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../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/components/toomanyrequestsresponseerrordata.mdx b/docs/components/toomanyrequestsresponseerrordata.mdx index f4ef13395..edc2b7de0 100644 --- a/docs/components/toomanyrequestsresponseerrordata.mdx +++ b/docs/components/toomanyrequestsresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for TooManyRequestsResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/topproviderinfo.mdx b/docs/components/topproviderinfo.mdx index c0fb34f1a..0a324fb77 100644 --- a/docs/components/topproviderinfo.mdx +++ b/docs/components/topproviderinfo.mdx @@ -9,6 +9,6 @@ Information about the top provider for this model | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context_length` | *OptionalNullable[int]* | ➖ | Context length from the top provider | 8192 | -| `is_moderated` | *bool* | ✅ | Whether the top provider moderates content | true | -| `max_completion_tokens` | *OptionalNullable[int]* | ➖ | 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 +| `context_length` | *OptionalNullable[int]* | :heavy_minus_sign: | Context length from the top provider | 8192 | +| `is_moderated` | *bool* | :heavy_check_mark: | Whether the top provider moderates content | true | +| `max_completion_tokens` | *OptionalNullable[int]* | :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/components/tournamentstats.mdx b/docs/components/tournamentstats.mdx index 7c4ad0cd7..bf6cd57c5 100644 --- a/docs/components/tournamentstats.mdx +++ b/docs/components/tournamentstats.mdx @@ -9,8 +9,8 @@ Placement distribution from tournament matches. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `first_place` | *Nullable[int]* | ✅ | N/A | -| `fourth_place` | *Nullable[int]* | ✅ | N/A | -| `second_place` | *Nullable[int]* | ✅ | N/A | -| `third_place` | *Nullable[int]* | ✅ | N/A | -| `total` | *Nullable[int]* | ✅ | N/A | \ No newline at end of file +| `first_place` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `fourth_place` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `second_place` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `third_place` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `total` | *Nullable[int]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/traceconfig.mdx b/docs/components/traceconfig.mdx index 0902a9624..9dadf7654 100644 --- a/docs/components/traceconfig.mdx +++ b/docs/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 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `generation_name` | *Optional[str]* | ➖ | N/A | | -| `parent_span_id` | *Optional[str]* | ➖ | N/A | | -| `span_name` | *Optional[str]* | ➖ | N/A | | -| `trace_id` | *Optional[str]* | ➖ | N/A | | -| `trace_name` | *Optional[str]* | ➖ | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | \ No newline at end of file +| `generation_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `parent_span_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `span_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `trace_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `trace_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/triggerinputtokens.mdx b/docs/components/triggerinputtokens.mdx index d117e4869..45784f009 100644 --- a/docs/components/triggerinputtokens.mdx +++ b/docs/components/triggerinputtokens.mdx @@ -6,5 +6,5 @@ title: "TriggerInputTokens" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.EditTypeInputTokens](../components/edittypeinputtokens.mdx) | ✅ | N/A | -| `value` | *int* | ✅ | N/A | \ No newline at end of file +| `type` | [components.EditTypeInputTokens](../components/edittypeinputtokens.mdx) | :heavy_check_mark: | N/A | +| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/tts.mdx b/docs/components/tts.mdx index 29c67e43d..3a4751890 100644 --- a/docs/components/tts.mdx +++ b/docs/components/tts.mdx @@ -6,6 +6,6 @@ title: "TTS" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/unauthorizedresponseerrordata.mdx b/docs/components/unauthorizedresponseerrordata.mdx index 66c9721a6..ff7c1ed43 100644 --- a/docs/components/unauthorizedresponseerrordata.mdx +++ b/docs/components/unauthorizedresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for UnauthorizedResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarkpricing.mdx b/docs/components/unifiedbenchmarkpricing.mdx index 3e86f72aa..322906a43 100644 --- a/docs/components/unifiedbenchmarkpricing.mdx +++ b/docs/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` | *str* | ✅ | Cost per output token (USD, decimal string). | 0.000015 | -| `prompt` | *str* | ✅ | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file +| `completion` | *str* | :heavy_check_mark: | Cost per output token (USD, decimal string). | 0.000015 | +| `prompt` | *str* | :heavy_check_mark: | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksaaitem.mdx b/docs/components/unifiedbenchmarksaaitem.mdx index ed664fe34..0a22591fe 100644 --- a/docs/components/unifiedbenchmarksaaitem.mdx +++ b/docs/components/unifiedbenchmarksaaitem.mdx @@ -6,10 +6,10 @@ title: "UnifiedBenchmarksAAItem" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `agentic_index` | *Nullable[float]* | ✅ | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | -| `coding_index` | *Nullable[float]* | ✅ | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | -| `display_name` | *str* | ✅ | Model name as listed on Artificial Analysis. | GPT-4o | -| `intelligence_index` | *Nullable[float]* | ✅ | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | -| `model_permaslug` | *str* | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | -| `pricing` | [Nullable[components.UnifiedBenchmarkPricing]](../components/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `source` | [components.UnifiedBenchmarksAAItemSource](../components/unifiedbenchmarksaaitemsource.mdx) | ✅ | Benchmark source discriminator. | | \ No newline at end of file +| `agentic_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | +| `coding_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | +| `display_name` | *str* | :heavy_check_mark: | Model name as listed on Artificial Analysis. | GPT-4o | +| `intelligence_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | +| `model_permaslug` | *str* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | +| `pricing` | [Nullable[components.UnifiedBenchmarkPricing]](../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](../components/unifiedbenchmarksaaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksdaitem.mdx b/docs/components/unifiedbenchmarksdaitem.mdx index 3f3b5c777..95f66134b 100644 --- a/docs/components/unifiedbenchmarksdaitem.mdx +++ b/docs/components/unifiedbenchmarksdaitem.mdx @@ -6,13 +6,13 @@ title: "UnifiedBenchmarksDAItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `arena` | *str* | ✅ | Arena this ranking belongs to. | models | -| `avg_generation_time_ms` | *Nullable[float]* | ✅ | Average generation time in milliseconds. | 3200 | -| `category` | *str* | ✅ | Category within the arena. | codecategories | -| `display_name` | *str* | ✅ | Human-readable model name from Design Arena. | Claude Sonnet 4 | -| `elo` | *float* | ✅ | ELO rating from head-to-head arena battles. | 1423 | -| `model_permaslug` | *str* | ✅ | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | -| `pricing` | [Nullable[components.UnifiedBenchmarkPricing]](../components/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `source` | [components.UnifiedBenchmarksDAItemSource](../components/unifiedbenchmarksdaitemsource.mdx) | ✅ | Benchmark source discriminator. | | -| `tournament_stats` | [components.TournamentStats](../components/tournamentstats.mdx) | ✅ | Placement distribution from tournament matches. | | -| `win_rate` | *float* | ✅ | Win rate as a percentage (0–100). | 72 | \ No newline at end of file +| `arena` | *str* | :heavy_check_mark: | Arena this ranking belongs to. | models | +| `avg_generation_time_ms` | *Nullable[float]* | :heavy_check_mark: | Average generation time in milliseconds. | 3200 | +| `category` | *str* | :heavy_check_mark: | Category within the arena. | codecategories | +| `display_name` | *str* | :heavy_check_mark: | Human-readable model name from Design Arena. | Claude Sonnet 4 | +| `elo` | *float* | :heavy_check_mark: | ELO rating from head-to-head arena battles. | 1423 | +| `model_permaslug` | *str* | :heavy_check_mark: | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | +| `pricing` | [Nullable[components.UnifiedBenchmarkPricing]](../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](../components/unifiedbenchmarksdaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | +| `tournament_stats` | [components.TournamentStats](../components/tournamentstats.mdx) | :heavy_check_mark: | Placement distribution from tournament matches. | | +| `win_rate` | *float* | :heavy_check_mark: | Win rate as a percentage (0–100). | 72 | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksmeta.mdx b/docs/components/unifiedbenchmarksmeta.mdx index b68e72df2..ea52df6e0 100644 --- a/docs/components/unifiedbenchmarksmeta.mdx +++ b/docs/components/unifiedbenchmarksmeta.mdx @@ -6,10 +6,10 @@ title: "UnifiedBenchmarksMeta" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `as_of` | *str* | ✅ | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | -| `citation` | *Nullable[str]* | ✅ | 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). | -| `model_count` | *int* | ✅ | Number of unique models in the response. | | -| `source` | [Nullable[components.UnifiedBenchmarksMetaSource]](../components/unifiedbenchmarksmetasource.mdx) | ✅ | The source filter applied, or null when all sources are returned. | artificial-analysis | -| `source_url` | *Nullable[str]* | ✅ | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | -| `task_type` | *Nullable[str]* | ✅ | The task_type filter applied, or null if showing all. | | -| `version` | [components.UnifiedBenchmarksMetaVersion](../components/unifiedbenchmarksmetaversion.mdx) | ✅ | Dataset version. | | \ No newline at end of file +| `as_of` | *str* | :heavy_check_mark: | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | +| `citation` | *Nullable[str]* | :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). | +| `model_count` | *int* | :heavy_check_mark: | Number of unique models in the response. | | +| `source` | [Nullable[components.UnifiedBenchmarksMetaSource]](../components/unifiedbenchmarksmetasource.mdx) | :heavy_check_mark: | The source filter applied, or null when all sources are returned. | artificial-analysis | +| `source_url` | *Nullable[str]* | :heavy_check_mark: | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | +| `task_type` | *Nullable[str]* | :heavy_check_mark: | The task_type filter applied, or null if showing all. | | +| `version` | [components.UnifiedBenchmarksMetaVersion](../components/unifiedbenchmarksmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksoritem.mdx b/docs/components/unifiedbenchmarksoritem.mdx index 2132c22ef..ec2f59459 100644 --- a/docs/components/unifiedbenchmarksoritem.mdx +++ b/docs/components/unifiedbenchmarksoritem.mdx @@ -6,12 +6,12 @@ title: "UnifiedBenchmarksORItem" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `accuracy` | *float* | ✅ | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | -| `accuracy_stddev` | *Nullable[float]* | ✅ | Standard deviation of run accuracy, or null for a single run. | 0.03 | -| `avg_cost_per_task` | *Nullable[float]* | ✅ | Average cost per task in USD, or null if unavailable. | 0.002 | -| `benchmark_type` | [components.UnifiedBenchmarksORItemBenchmarkType](../components/unifiedbenchmarksoritembenchmarktype.mdx) | ✅ | OpenRouter benchmark evaluation type. | gpqa_diamond | -| `display_name` | *str* | ✅ | Human-readable model name. | GPT-4o | -| `last_run_timestamp` | *str* | ✅ | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | -| `model_permaslug` | *str* | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | -| `source` | [components.UnifiedBenchmarksORItemSource](../components/unifiedbenchmarksoritemsource.mdx) | ✅ | Benchmark source discriminator. | | -| `total_tasks` | *int* | ✅ | Total benchmark tasks across runs. | 300 | \ No newline at end of file +| `accuracy` | *float* | :heavy_check_mark: | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | +| `accuracy_stddev` | *Nullable[float]* | :heavy_check_mark: | Standard deviation of run accuracy, or null for a single run. | 0.03 | +| `avg_cost_per_task` | *Nullable[float]* | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.002 | +| `benchmark_type` | [components.UnifiedBenchmarksORItemBenchmarkType](../components/unifiedbenchmarksoritembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter benchmark evaluation type. | gpqa_diamond | +| `display_name` | *str* | :heavy_check_mark: | Human-readable model name. | GPT-4o | +| `last_run_timestamp` | *str* | :heavy_check_mark: | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | +| `model_permaslug` | *str* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | +| `source` | [components.UnifiedBenchmarksORItemSource](../components/unifiedbenchmarksoritemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | +| `total_tasks` | *int* | :heavy_check_mark: | Total benchmark tasks across runs. | 300 | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksresponse.mdx b/docs/components/unifiedbenchmarksresponse.mdx index acfc1a88d..ee48e6457 100644 --- a/docs/components/unifiedbenchmarksresponse.mdx +++ b/docs/components/unifiedbenchmarksresponse.mdx @@ -6,5 +6,5 @@ title: "UnifiedBenchmarksResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.UnifiedBenchmarksResponseData](../components/unifiedbenchmarksresponsedata.mdx)] | ✅ | N/A | | -| `meta` | [components.UnifiedBenchmarksMeta](../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` | List[[components.UnifiedBenchmarksResponseData](../components/unifiedbenchmarksresponsedata.mdx)] | :heavy_check_mark: | N/A | | +| `meta` | [components.UnifiedBenchmarksMeta](../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/components/unifiedbenchmarkssearchitem.mdx b/docs/components/unifiedbenchmarkssearchitem.mdx index 431e9d9da..40b4f0bea 100644 --- a/docs/components/unifiedbenchmarkssearchitem.mdx +++ b/docs/components/unifiedbenchmarkssearchitem.mdx @@ -6,16 +6,16 @@ title: "UnifiedBenchmarksSearchItem" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `avg_cost_per_task` | *Nullable[float]* | ✅ | Average cost per task in USD, or null if unavailable. | 0.031 | -| `avg_latency_per_task_ms` | *Nullable[float]* | ✅ | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | -| `benchmark_type` | [components.UnifiedBenchmarksSearchItemBenchmarkType](../components/unifiedbenchmarkssearchitembenchmarktype.mdx) | ✅ | OpenRouter search benchmark. | search_browsecomp | -| `display_name` | *str* | ✅ | Human-readable model name. | GPT-4o | -| `last_run_timestamp` | *str* | ✅ | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | -| `model_permaslug` | *str* | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | -| `primary_metric` | [components.PrimaryMetric](../components/primarymetric.mdx) | ✅ | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | -| `primary_score` | *float* | ✅ | 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 | -| `run_config` | [Optional[components.UnifiedBenchmarksSearchRunConfig]](../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. | | -| `search_engine` | *str* | ✅ | Search engine the published configuration used. | exa | -| `search_surface` | [components.SearchSurface](../components/searchsurface.mdx) | ✅ | Request surface the published configuration went through. | server-tool | -| `source` | [components.UnifiedBenchmarksSearchItemSource](../components/unifiedbenchmarkssearchitemsource.mdx) | ✅ | Benchmark source discriminator. | | -| `total_tasks` | *int* | ✅ | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file +| `avg_cost_per_task` | *Nullable[float]* | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.031 | +| `avg_latency_per_task_ms` | *Nullable[float]* | :heavy_check_mark: | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | +| `benchmark_type` | [components.UnifiedBenchmarksSearchItemBenchmarkType](../components/unifiedbenchmarkssearchitembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter search benchmark. | search_browsecomp | +| `display_name` | *str* | :heavy_check_mark: | Human-readable model name. | GPT-4o | +| `last_run_timestamp` | *str* | :heavy_check_mark: | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | +| `model_permaslug` | *str* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | +| `primary_metric` | [components.PrimaryMetric](../components/primarymetric.mdx) | :heavy_check_mark: | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | +| `primary_score` | *float* | :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 | +| `run_config` | [Optional[components.UnifiedBenchmarksSearchRunConfig]](../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. | | +| `search_engine` | *str* | :heavy_check_mark: | Search engine the published configuration used. | exa | +| `search_surface` | [components.SearchSurface](../components/searchsurface.mdx) | :heavy_check_mark: | Request surface the published configuration went through. | server-tool | +| `source` | [components.UnifiedBenchmarksSearchItemSource](../components/unifiedbenchmarkssearchitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | +| `total_tasks` | *int* | :heavy_check_mark: | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarkssearchrunconfig.mdx b/docs/components/unifiedbenchmarkssearchrunconfig.mdx index e4872e0ba..21f463fd8 100644 --- a/docs/components/unifiedbenchmarkssearchrunconfig.mdx +++ b/docs/components/unifiedbenchmarkssearchrunconfig.mdx @@ -9,6 +9,6 @@ Published lane configuration, included only when include_run_config=true. Only t | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `max_agent_turns` | *Nullable[int]* | ✅ | Agent-turn count for the published lane, or null for plugin lanes. | 25 | -| `reasoning_effort` | *Nullable[str]* | ✅ | Reasoning effort configured for the published lane, or null when omitted. | high | -| `temperature` | *Nullable[float]* | ✅ | Sampling temperature configured for the published lane, or null when omitted. | 0.2 | \ No newline at end of file +| `max_agent_turns` | *Nullable[int]* | :heavy_check_mark: | Agent-turn count for the published lane, or null for plugin lanes. | 25 | +| `reasoning_effort` | *Nullable[str]* | :heavy_check_mark: | Reasoning effort configured for the published lane, or null when omitted. | high | +| `temperature` | *Nullable[float]* | :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/components/uniqueinsight.mdx b/docs/components/uniqueinsight.mdx index eea1ee281..2dd2e0e31 100644 --- a/docs/components/uniqueinsight.mdx +++ b/docs/components/uniqueinsight.mdx @@ -6,5 +6,5 @@ title: "UniqueInsight" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `insight` | *str* | ✅ | N/A | -| `model` | *str* | ✅ | N/A | \ No newline at end of file +| `insight` | *str* | :heavy_check_mark: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/unknown.mdx b/docs/components/unknown.mdx index a15b82456..77c502f0a 100644 --- a/docs/components/unknown.mdx +++ b/docs/components/unknown.mdx @@ -6,6 +6,6 @@ title: "Unknown" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/unprocessableentityresponseerrordata.mdx b/docs/components/unprocessableentityresponseerrordata.mdx index 423b9c7a9..5a7e1816a 100644 --- a/docs/components/unprocessableentityresponseerrordata.mdx +++ b/docs/components/unprocessableentityresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for UnprocessableEntityResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | ✅ | N/A | -| `message` | *str* | ✅ | N/A | -| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `code` | *int* | :heavy_check_mark: | N/A | +| `message` | *str* | :heavy_check_mark: | N/A | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/updatebyokkeyrequest.mdx b/docs/components/updatebyokkeyrequest.mdx index a8bef74c3..a9c7eb201 100644 --- a/docs/components/updatebyokkeyrequest.mdx +++ b/docs/components/updatebyokkeyrequest.mdx @@ -6,14 +6,14 @@ title: "UpdateBYOKKeyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_api_key_hashes` | List[*str*] | ➖ | 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"
] | -| `allowed_models` | List[*str*] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declared_region` | [OptionalNullable[components.UpdateBYOKKeyRequestDeclaredRegion]](../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 | -| `declared_zdr` | *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` | *Optional[bool]* | ➖ | Whether this credential is disabled. | false | -| `is_byok_only` | *Optional[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 | -| `is_fallback` | *Optional[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 | -| `is_required` | *Optional[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` | *Optional[str]* | ➖ | 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[str]* | ➖ | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file +| `allowed_api_key_hashes` | List[*str*] | :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"
] | +| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declared_region` | [OptionalNullable[components.UpdateBYOKKeyRequestDeclaredRegion]](../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 | +| `declared_zdr` | *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential is disabled. | false | +| `is_byok_only` | *Optional[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 | +| `is_fallback` | *Optional[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 | +| `is_required` | *Optional[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` | *Optional[str]* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file diff --git a/docs/components/updatebyokkeyresponse.mdx b/docs/components/updatebyokkeyresponse.mdx index 4249563ec..b1eafbef0 100644 --- a/docs/components/updatebyokkeyresponse.mdx +++ b/docs/components/updatebyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.BYOKKey](../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](../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/components/updateenduserrequest.mdx b/docs/components/updateenduserrequest.mdx index 4454ea375..72a1c5ade 100644 --- a/docs/components/updateenduserrequest.mdx +++ b/docs/components/updateenduserrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateEndUserRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `is_active` | *bool* | ✅ | Registration state only; does not enforce inference access. | true | \ No newline at end of file +| `is_active` | *bool* | :heavy_check_mark: | Registration state only; does not enforce inference access. | true | \ No newline at end of file diff --git a/docs/components/updateguardrailrequest.mdx b/docs/components/updateguardrailrequest.mdx index 3bbb2b444..dfd991a99 100644 --- a/docs/components/updateguardrailrequest.mdx +++ b/docs/components/updateguardrailrequest.mdx @@ -6,24 +6,25 @@ title: "UpdateGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | -| `allowed_models` | List[*str*] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `allowed_providers` | List[*str*] | ➖ | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../components/contentfilterentry.mdx)] | ➖ | Custom regex content filters to apply. Set to null to remove. | null | -| `description` | *OptionalNullable[str]* | ➖ | New description for the guardrail | Updated description | -| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`enforce_zdr`~~ | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | -| `ignored_models` | List[*str*] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *OptionalNullable[float]* | ➖ | New spending limit in USD | 75 | -| `name` | *Optional[str]* | ➖ | New name for the guardrail | Updated Guardrail Name | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file +| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | false | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | +| `allowed_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | +| `allowed_providers` | List[*str*] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the guardrail | Updated description | +| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`enforce_zdr`~~ | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | +| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit in USD | 75 | +| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../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/components/updateguardrailresponse.mdx b/docs/components/updateguardrailresponse.mdx index 3cfd101fd..510bac097 100644 --- a/docs/components/updateguardrailresponse.mdx +++ b/docs/components/updateguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Guardrail](../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](../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/components/updateinternrequest.mdx b/docs/components/updateinternrequest.mdx index 423c25040..cd20dcfbb 100644 --- a/docs/components/updateinternrequest.mdx +++ b/docs/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[str]* | ➖ | New free-form description. Null clears it. | -| `instructions` | *OptionalNullable[str]* | ➖ | New standing instructions. Null clears them. | -| `model` | *OptionalNullable[str]* | ➖ | 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` | *Optional[str]* | ➖ | New intern name, unique per creator within the workspace. | \ No newline at end of file +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New free-form description. Null clears it. | +| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | New standing instructions. Null clears them. | +| `model` | *OptionalNullable[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | New intern name, unique per creator within the workspace. | \ No newline at end of file diff --git a/docs/components/updateobservabilitydestinationrequest.mdx b/docs/components/updateobservabilitydestinationrequest.mdx index 2ea89116a..af5a61e64 100644 --- a/docs/components/updateobservabilitydestinationrequest.mdx +++ b/docs/components/updateobservabilitydestinationrequest.mdx @@ -6,15 +6,15 @@ title: "UpdateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | ➖ | 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 | -| `broadcast_generation_cost` | *Optional[bool]* | ➖ | Whether to include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *Optional[bool]* | ➖ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *Optional[bool]* | ➖ | Whether to include identity generation metadata. | false | -| `broadcast_generation_request_context` | *Optional[bool]* | ➖ | Whether to include request-context generation metadata. | false | -| `config` | Dict[str, *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` | *Optional[bool]* | ➖ | Whether the destination is enabled. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../components/observabilityfilterrulesconfignullable.mdx) | ➖ | N/A | null | -| `name` | *Optional[str]* | ➖ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *Optional[bool]* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegionInput](../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"
] | -| `sampling_rate` | *Optional[float]* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *Optional[bool]* | :heavy_minus_sign: | Whether to include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *Optional[bool]* | :heavy_minus_sign: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *Optional[bool]* | :heavy_minus_sign: | Whether to include identity generation metadata. | false | +| `broadcast_generation_request_context` | *Optional[bool]* | :heavy_minus_sign: | Whether to include request-context generation metadata. | false | +| `config` | Dict[str, *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` | *Optional[bool]* | :heavy_minus_sign: | Whether the destination is enabled. | true | +| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../components/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | N/A | null | +| `name` | *Optional[str]* | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegionInput](../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"
] | +| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file diff --git a/docs/components/updateobservabilitydestinationresponse.mdx b/docs/components/updateobservabilitydestinationresponse.mdx index 8104fe2ea..7c7ec75d1 100644 --- a/docs/components/updateobservabilitydestinationresponse.mdx +++ b/docs/components/updateobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ObservabilityDestination](../components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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](../components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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/components/updateorganizationsettingsrequest.mdx b/docs/components/updateorganizationsettingsrequest.mdx index 81d790790..d46fb370c 100644 --- a/docs/components/updateorganizationsettingsrequest.mdx +++ b/docs/components/updateorganizationsettingsrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateOrganizationSettingsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is_filtered_model_catalog_enabled` | *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 +| `is_filtered_model_catalog_enabled` | *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/components/updateprivateendpointpricingrequest.mdx b/docs/components/updateprivateendpointpricingrequest.mdx index 1f7652eaa..96fbfd329 100644 --- a/docs/components/updateprivateendpointpricingrequest.mdx +++ b/docs/components/updateprivateendpointpricingrequest.mdx @@ -6,4 +6,4 @@ title: "UpdatePrivateEndpointPricingRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `pricing` | [components.PrivateEndpointPricing](../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](../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/components/updateprivateendpointrequest.mdx b/docs/components/updateprivateendpointrequest.mdx index 850b32735..ea23134f7 100644 --- a/docs/components/updateprivateendpointrequest.mdx +++ b/docs/components/updateprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "UpdatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `base_url` | *Optional[str]* | ➖ | 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 | -| `declared_region` | [OptionalNullable[components.UpdatePrivateEndpointRequestDeclaredRegion]](../components/updateprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | -| `declared_zdr` | *OptionalNullable[bool]* | ➖ | Attest that this deployment retains no prompt or completion data. | | -| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `base_url` | *Optional[str]* | :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 | +| `declared_region` | [OptionalNullable[components.UpdatePrivateEndpointRequestDeclaredRegion]](../components/updateprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | +| `declared_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | +| `upstream_model_id` | *str* | :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/components/updatescimgroupmappingrequest.mdx b/docs/components/updatescimgroupmappingrequest.mdx index a3bc0914e..8206d9182 100644 --- a/docs/components/updatescimgroupmappingrequest.mdx +++ b/docs/components/updatescimgroupmappingrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateScimGroupMappingRequest" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `role` | [components.UpdateScimGroupMappingRequestRole](../components/updatescimgroupmappingrequestrole.mdx) | ✅ | N/A | \ No newline at end of file +| `role` | [components.UpdateScimGroupMappingRequestRole](../components/updatescimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/updatescimgroupmappingresponse.mdx b/docs/components/updatescimgroupmappingresponse.mdx index c247528ea..651230ce1 100644 --- a/docs/components/updatescimgroupmappingresponse.mdx +++ b/docs/components/updatescimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ScimGroupMapping](../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](../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/components/updateworkspacerequest.mdx b/docs/components/updateworkspacerequest.mdx index d7ddcb804..d0d068f60 100644 --- a/docs/components/updateworkspacerequest.mdx +++ b/docs/components/updateworkspacerequest.mdx @@ -6,15 +6,15 @@ title: "UpdateWorkspaceRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `default_image_model` | *OptionalNullable[str]* | ➖ | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | ➖ | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | ➖ | New description for the workspace | Updated description | -| `disabled_server_tools` | List[[components.UpdateWorkspaceRequestDisabledServerTool](../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"
] | -| `io_logging_api_key_ids` | List[*int*] | ➖ | Optional array of API key IDs to filter I/O logging | null | -| `io_logging_sampling_rate` | *Optional[float]* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | ➖ | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | ➖ | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | ➖ | Whether private logging is enabled | false | -| `name` | *Optional[str]* | ➖ | New name for the workspace | Updated Workspace | -| `slug` | *Optional[str]* | ➖ | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file +| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the workspace | Updated description | +| `disabled_server_tools` | List[[components.UpdateWorkspaceRequestDisabledServerTool](../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"
] | +| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | +| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | +| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | +| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | +| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | +| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the workspace | Updated Workspace | +| `slug` | *Optional[str]* | :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/components/updateworkspaceresponse.mdx b/docs/components/updateworkspaceresponse.mdx index 4c757827f..bb50c7c71 100644 --- a/docs/components/updateworkspaceresponse.mdx +++ b/docs/components/updateworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Workspace](../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](../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/components/upscalefactor.mdx b/docs/components/upscalefactor.mdx index 3bb35a91f..8ab4fef86 100644 --- a/docs/components/upscalefactor.mdx +++ b/docs/components/upscalefactor.mdx @@ -9,5 +9,5 @@ Supported upscale factor range for video upscaling models | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `max` | *OptionalNullable[float]* | ➖ | N/A | -| `min` | *OptionalNullable[float]* | ➖ | N/A | \ No newline at end of file +| `max` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `min` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/upsertworkspacebudgetrequest.mdx b/docs/components/upsertworkspacebudgetrequest.mdx index ce00aab13..7417e0844 100644 --- a/docs/components/upsertworkspacebudgetrequest.mdx +++ b/docs/components/upsertworkspacebudgetrequest.mdx @@ -6,5 +6,5 @@ title: "UpsertWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *float* | ✅ | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *float* | :heavy_check_mark: | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file diff --git a/docs/components/upsertworkspacebudgetresponse.mdx b/docs/components/upsertworkspacebudgetresponse.mdx index 0a23c5a79..20e9f498c 100644 --- a/docs/components/upsertworkspacebudgetresponse.mdx +++ b/docs/components/upsertworkspacebudgetresponse.mdx @@ -6,5 +6,5 @@ title: "UpsertWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.WorkspaceBudget](../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"
} | -| `include_byok_in_budgets` | *Optional[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](../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"
} | +| `include_byok_in_budgets` | *Optional[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/components/upstream.mdx b/docs/components/upstream.mdx index 69d8b821b..961a07704 100644 --- a/docs/components/upstream.mdx +++ b/docs/components/upstream.mdx @@ -9,5 +9,5 @@ The upstream batch deletion outcome; omitted when no provider was assigned. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `provider` | *str* | ✅ | The provider name stored on the batch. | OpenAI | -| `status` | [components.BatchDeletionOutcome](../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` | *str* | :heavy_check_mark: | The provider name stored on the batch. | OpenAI | +| `status` | [components.BatchDeletionOutcome](../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/components/urlcitation.mdx b/docs/components/urlcitation.mdx index d23353c99..0386b33d8 100644 --- a/docs/components/urlcitation.mdx +++ b/docs/components/urlcitation.mdx @@ -6,9 +6,9 @@ title: "URLCitation" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `content` | *Optional[str]* | ➖ | N/A | -| `end_index` | *int* | ✅ | N/A | -| `start_index` | *int* | ✅ | N/A | -| `title` | *str* | ✅ | N/A | -| `type` | [components.URLCitationType](../components/urlcitationtype.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `end_index` | *int* | :heavy_check_mark: | N/A | +| `start_index` | *int* | :heavy_check_mark: | N/A | +| `title` | *str* | :heavy_check_mark: | N/A | +| `type` | [components.URLCitationType](../components/urlcitationtype.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/usage.mdx b/docs/components/usage.mdx index 3aa98f3a9..bdccd1463 100644 --- a/docs/components/usage.mdx +++ b/docs/components/usage.mdx @@ -6,12 +6,12 @@ title: "Usage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `input_tokens` | *int* | ✅ | N/A | | -| `input_tokens_details` | [components.InputTokensDetails](../components/inputtokensdetails.mdx) | ✅ | N/A | | -| `output_tokens` | *int* | ✅ | N/A | | -| `output_tokens_details` | [components.OutputTokensDetails](../components/outputtokensdetails.mdx) | ✅ | N/A | | -| `total_tokens` | *int* | ✅ | N/A | | -| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | -| `cost_details` | [Optional[components.UsageCostDetails]](../components/usagecostdetails.mdx) | ➖ | N/A | | -| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `server_tool_use_details` | [OptionalNullable[components.ServerToolUseDetails]](../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 +| `input_tokens` | *int* | :heavy_check_mark: | N/A | | +| `input_tokens_details` | [components.InputTokensDetails](../components/inputtokensdetails.mdx) | :heavy_check_mark: | N/A | | +| `output_tokens` | *int* | :heavy_check_mark: | N/A | | +| `output_tokens_details` | [components.OutputTokensDetails](../components/outputtokensdetails.mdx) | :heavy_check_mark: | N/A | | +| `total_tokens` | *int* | :heavy_check_mark: | N/A | | +| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | +| `cost_details` | [Optional[components.UsageCostDetails]](../components/usagecostdetails.mdx) | :heavy_minus_sign: | N/A | | +| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `server_tool_use_details` | [OptionalNullable[components.ServerToolUseDetails]](../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/components/usagecostdetails.mdx b/docs/components/usagecostdetails.mdx index 508e844be..f7efeafac 100644 --- a/docs/components/usagecostdetails.mdx +++ b/docs/components/usagecostdetails.mdx @@ -6,7 +6,7 @@ title: "UsageCostDetails" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `server_tool_cost` | *OptionalNullable[float]* | ➖ | 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. | -| `upstream_inference_cost` | *OptionalNullable[float]* | ➖ | N/A | -| `upstream_inference_input_cost` | *float* | ✅ | N/A | -| `upstream_inference_output_cost` | *float* | ✅ | N/A | \ No newline at end of file +| `server_tool_cost` | *OptionalNullable[float]* | :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. | +| `upstream_inference_cost` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | +| `upstream_inference_input_cost` | *float* | :heavy_check_mark: | N/A | +| `upstream_inference_output_cost` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/userlocation.mdx b/docs/components/userlocation.mdx index 6aed589dc..2b1814dbe 100644 --- a/docs/components/userlocation.mdx +++ b/docs/components/userlocation.mdx @@ -9,8 +9,8 @@ Approximate user location for location-biased search results. Passed through to | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `city` | *OptionalNullable[str]* | ➖ | N/A | -| `country` | *OptionalNullable[str]* | ➖ | N/A | -| `region` | *OptionalNullable[str]* | ➖ | N/A | -| `timezone` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [components.WebSearchPluginType](../components/websearchplugintype.mdx) | ✅ | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [components.WebSearchPluginType](../components/websearchplugintype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/validateprivateendpointrequest.mdx b/docs/components/validateprivateendpointrequest.mdx index 096c78fc9..d41a02a62 100644 --- a/docs/components/validateprivateendpointrequest.mdx +++ b/docs/components/validateprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "ValidatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `workspace_id` | *str* | ✅ | 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 +| `workspace_id` | *str* | :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/components/vaulteffectivesecret.mdx b/docs/components/vaulteffectivesecret.mdx index 7fd9791a5..54d681fca 100644 --- a/docs/components/vaulteffectivesecret.mdx +++ b/docs/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 | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | N/A | -| `fingerprint` | *Nullable[str]* | ✅ | N/A | -| `hosts` | List[*str*] | ✅ | N/A | -| `name` | *str* | ✅ | N/A | -| `scope` | [components.VaultEffectiveSecretScope](../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 +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | +| `fingerprint` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `hosts` | List[*str*] | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `scope` | [components.VaultEffectiveSecretScope](../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/components/vaulteffectivesecretlistresponse.mdx b/docs/components/vaulteffectivesecretlistresponse.mdx index e9e7dcc60..84fe50a0b 100644 --- a/docs/components/vaulteffectivesecretlistresponse.mdx +++ b/docs/components/vaulteffectivesecretlistresponse.mdx @@ -9,5 +9,5 @@ One page of the secrets an intern receives, one entry per name. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.VaultEffectiveSecret](../components/vaulteffectivesecret.mdx)] | ✅ | N/A | -| `has_more` | *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` | List[[components.VaultEffectiveSecret](../components/vaulteffectivesecret.mdx)] | :heavy_check_mark: | N/A | +| `has_more` | *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/components/vaultsecret.mdx b/docs/components/vaultsecret.mdx index d001e0188..912186ec2 100644 --- a/docs/components/vaultsecret.mdx +++ b/docs/components/vaultsecret.mdx @@ -9,7 +9,7 @@ Metadata for one stored secret. The secret value is never returned. `fingerprint | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | N/A | -| `fingerprint` | *Nullable[str]* | ✅ | N/A | -| `hosts` | List[*str*] | ✅ | N/A | -| `name` | *str* | ✅ | N/A | \ No newline at end of file +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | +| `fingerprint` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `hosts` | List[*str*] | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/vaultsecretcopyrequest.mdx b/docs/components/vaultsecretcopyrequest.mdx index 887a6dca6..78fb27510 100644 --- a/docs/components/vaultsecretcopyrequest.mdx +++ b/docs/components/vaultsecretcopyrequest.mdx @@ -9,4 +9,4 @@ Workspace secrets to copy into the intern scope. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `names` | List[*str*] | ✅ | 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` | List[*str*] | :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/components/vaultsecretcopyresponse.mdx b/docs/components/vaultsecretcopyresponse.mdx index 125157afe..60ce995cb 100644 --- a/docs/components/vaultsecretcopyresponse.mdx +++ b/docs/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` | List[[components.VaultSecret](../components/vaultsecret.mdx)] | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.VaultSecret](../components/vaultsecret.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/vaultsecretlistresponse.mdx b/docs/components/vaultsecretlistresponse.mdx index f769e3916..0b17bf589 100644 --- a/docs/components/vaultsecretlistresponse.mdx +++ b/docs/components/vaultsecretlistresponse.mdx @@ -9,5 +9,5 @@ One page of secret metadata for the selected scope. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.VaultSecret](../components/vaultsecret.mdx)] | ✅ | N/A | -| `has_more` | *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` | List[[components.VaultSecret](../components/vaultsecret.mdx)] | :heavy_check_mark: | N/A | +| `has_more` | *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/components/vaultsecretresponse.mdx b/docs/components/vaultsecretresponse.mdx index 5aedbf0e6..db67f3cfa 100644 --- a/docs/components/vaultsecretresponse.mdx +++ b/docs/components/vaultsecretresponse.mdx @@ -9,4 +9,4 @@ Metadata for the stored secret. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.VaultSecret](../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](../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/components/vaultsecretwriterequest.mdx b/docs/components/vaultsecretwriterequest.mdx index b0b3328ad..92dcbeadd 100644 --- a/docs/components/vaultsecretwriterequest.mdx +++ b/docs/components/vaultsecretwriterequest.mdx @@ -9,5 +9,5 @@ Secret value and the exact hostnames it may be released to. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hosts` | List[*str*] | ✅ | 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` | *str* | ✅ | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | \ No newline at end of file +| `hosts` | List[*str*] | :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` | *str* | :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/components/videogeneration.mdx b/docs/components/videogeneration.mdx index 482122145..0f7cc13e2 100644 --- a/docs/components/videogeneration.mdx +++ b/docs/components/videogeneration.mdx @@ -6,6 +6,6 @@ title: "VideoGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/videogenerationrequest.mdx b/docs/components/videogenerationrequest.mdx index 41b9387f7..8f8569b74 100644 --- a/docs/components/videogenerationrequest.mdx +++ b/docs/components/videogenerationrequest.mdx @@ -6,21 +6,21 @@ title: "VideoGenerationRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aspect_ratio` | [Optional[components.VideoGenerationRequestAspectRatio]](../components/videogenerationrequestaspectratio.mdx) | ➖ | Aspect ratio of the generated video | 16:9 | -| `callback_url` | *Optional[str]* | ➖ | 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` | *Optional[int]* | ➖ | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | -| `duration` | *Optional[int]* | ➖ | Duration of the generated video in seconds | 8 | -| `frame_images` | List[[components.FrameImage](../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. | | -| `generate_audio` | *Optional[bool]* | ➖ | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | -| `input_references` | List[[components.InputReference](../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` | *str* | ✅ | N/A | | -| `previous_job_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.VideoGenerationRequestProvider]](../components/videogenerationrequestprovider.mdx) | ➖ | Provider-specific passthrough configuration | | -| `resolution` | [Optional[components.VideoGenerationRequestResolution]](../components/videogenerationrequestresolution.mdx) | ➖ | Resolution of the generated video | 720p | -| `seed` | *Optional[int]* | ➖ | 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. | | -| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | -| `trace` | [Optional[components.TraceConfig]](../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"
} | -| `upscale_factor` | *Optional[float]* | ➖ | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | -| `user` | *Optional[str]* | ➖ | 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 +| `aspect_ratio` | [Optional[components.VideoGenerationRequestAspectRatio]](../components/videogenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | +| `callback_url` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | +| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | +| `frame_images` | List[[components.FrameImage](../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. | | +| `generate_audio` | *Optional[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 | +| `input_references` | List[[components.InputReference](../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` | *str* | :heavy_check_mark: | N/A | | +| `previous_job_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | [Optional[components.VideoGenerationRequestProvider]](../components/videogenerationrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | +| `resolution` | [Optional[components.VideoGenerationRequestResolution]](../components/videogenerationrequestresolution.mdx) | :heavy_minus_sign: | Resolution of the generated video | 720p | +| `seed` | *Optional[int]* | :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. | | +| `session_id` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | +| `trace` | [Optional[components.TraceConfig]](../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"
} | +| `upscale_factor` | *Optional[float]* | :heavy_minus_sign: | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | +| `user` | *Optional[str]* | :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/components/videogenerationrequestoptions.mdx b/docs/components/videogenerationrequestoptions.mdx index 62b937bfc..669232418 100644 --- a/docs/components/videogenerationrequestoptions.mdx +++ b/docs/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` | Dict[str, *Any*] | ➖ | N/A | -| `ai21` | Dict[str, *Any*] | ➖ | N/A | -| `aion_labs` | Dict[str, *Any*] | ➖ | N/A | -| `akashml` | Dict[str, *Any*] | ➖ | N/A | -| `alibaba` | Dict[str, *Any*] | ➖ | N/A | -| `amazon_bedrock` | Dict[str, *Any*] | ➖ | N/A | -| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | -| `amazon_nova` | Dict[str, *Any*] | ➖ | N/A | -| `ambient` | Dict[str, *Any*] | ➖ | N/A | -| `anthropic` | Dict[str, *Any*] | ➖ | N/A | -| `anthropic_2` | Dict[str, *Any*] | ➖ | N/A | -| `anyscale` | Dict[str, *Any*] | ➖ | N/A | -| `arcee_ai` | Dict[str, *Any*] | ➖ | N/A | -| `assemblyai` | Dict[str, *Any*] | ➖ | N/A | -| `atlas_cloud` | Dict[str, *Any*] | ➖ | N/A | -| `atoma` | Dict[str, *Any*] | ➖ | N/A | -| `avian` | Dict[str, *Any*] | ➖ | N/A | -| `azure` | Dict[str, *Any*] | ➖ | N/A | -| `baidu` | Dict[str, *Any*] | ➖ | N/A | -| `baseten` | Dict[str, *Any*] | ➖ | N/A | -| `black_forest_labs` | Dict[str, *Any*] | ➖ | N/A | -| `byteplus` | Dict[str, *Any*] | ➖ | N/A | -| `centml` | Dict[str, *Any*] | ➖ | N/A | -| `cerebras` | Dict[str, *Any*] | ➖ | N/A | -| `chutes` | Dict[str, *Any*] | ➖ | N/A | -| `cirrascale` | Dict[str, *Any*] | ➖ | N/A | -| `clarifai` | Dict[str, *Any*] | ➖ | N/A | -| `claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | -| `cloudflare` | Dict[str, *Any*] | ➖ | N/A | -| `cohere` | Dict[str, *Any*] | ➖ | N/A | -| `coreweave` | Dict[str, *Any*] | ➖ | N/A | -| `cosine` | Dict[str, *Any*] | ➖ | N/A | -| `crofai` | Dict[str, *Any*] | ➖ | N/A | -| `crucible` | Dict[str, *Any*] | ➖ | N/A | -| `crusoe` | Dict[str, *Any*] | ➖ | N/A | -| `darkbloom` | Dict[str, *Any*] | ➖ | N/A | -| `databricks` | Dict[str, *Any*] | ➖ | N/A | -| `decart` | Dict[str, *Any*] | ➖ | N/A | -| `deepgram` | Dict[str, *Any*] | ➖ | N/A | -| `deepinfra` | Dict[str, *Any*] | ➖ | N/A | -| `deepseek` | Dict[str, *Any*] | ➖ | N/A | -| `dekallm` | Dict[str, *Any*] | ➖ | N/A | -| `digitalocean` | Dict[str, *Any*] | ➖ | N/A | -| `elevenlabs` | Dict[str, *Any*] | ➖ | N/A | -| `enfer` | Dict[str, *Any*] | ➖ | N/A | -| `fake_provider` | Dict[str, *Any*] | ➖ | N/A | -| `featherless` | Dict[str, *Any*] | ➖ | N/A | -| `fireworks` | Dict[str, *Any*] | ➖ | N/A | -| `fish_audio` | Dict[str, *Any*] | ➖ | N/A | -| `friendli` | Dict[str, *Any*] | ➖ | N/A | -| `gmicloud` | Dict[str, *Any*] | ➖ | N/A | -| `google_ai_studio` | Dict[str, *Any*] | ➖ | N/A | -| `google_vertex` | Dict[str, *Any*] | ➖ | N/A | -| `gopomelo` | Dict[str, *Any*] | ➖ | N/A | -| `groq` | Dict[str, *Any*] | ➖ | N/A | -| `heygen` | Dict[str, *Any*] | ➖ | N/A | -| `huggingface` | Dict[str, *Any*] | ➖ | N/A | -| `hyperbolic` | Dict[str, *Any*] | ➖ | N/A | -| `hyperbolic_quantized` | Dict[str, *Any*] | ➖ | N/A | -| `inception` | Dict[str, *Any*] | ➖ | N/A | -| `inceptron` | Dict[str, *Any*] | ➖ | N/A | -| `inferact_vllm` | Dict[str, *Any*] | ➖ | N/A | -| `inference_net` | Dict[str, *Any*] | ➖ | N/A | -| `infermatic` | Dict[str, *Any*] | ➖ | N/A | -| `inflection` | Dict[str, *Any*] | ➖ | N/A | -| `inocloud` | Dict[str, *Any*] | ➖ | N/A | -| `io_net` | Dict[str, *Any*] | ➖ | N/A | -| `ionstream` | Dict[str, *Any*] | ➖ | N/A | -| `klusterai` | Dict[str, *Any*] | ➖ | N/A | -| `krea` | Dict[str, *Any*] | ➖ | N/A | -| `lambda_` | Dict[str, *Any*] | ➖ | N/A | -| `lepton` | Dict[str, *Any*] | ➖ | N/A | -| `liquid` | Dict[str, *Any*] | ➖ | N/A | -| `lynn` | Dict[str, *Any*] | ➖ | N/A | -| `lynn_private` | Dict[str, *Any*] | ➖ | N/A | -| `makora` | Dict[str, *Any*] | ➖ | N/A | -| `mancer` | Dict[str, *Any*] | ➖ | N/A | -| `mancer_old` | Dict[str, *Any*] | ➖ | N/A | -| `mara` | Dict[str, *Any*] | ➖ | N/A | -| `meta` | Dict[str, *Any*] | ➖ | N/A | -| `minimax` | Dict[str, *Any*] | ➖ | N/A | -| `mistral` | Dict[str, *Any*] | ➖ | N/A | -| `modal` | Dict[str, *Any*] | ➖ | N/A | -| `modelrun` | Dict[str, *Any*] | ➖ | N/A | -| `modular` | Dict[str, *Any*] | ➖ | N/A | -| `moonshotai` | Dict[str, *Any*] | ➖ | N/A | -| `morph` | Dict[str, *Any*] | ➖ | N/A | -| `ncompass` | Dict[str, *Any*] | ➖ | N/A | -| `near_ai` | Dict[str, *Any*] | ➖ | N/A | -| `nebius` | Dict[str, *Any*] | ➖ | N/A | -| `nex_agi` | Dict[str, *Any*] | ➖ | N/A | -| `nextbit` | Dict[str, *Any*] | ➖ | N/A | -| `nineteen` | Dict[str, *Any*] | ➖ | N/A | -| `novita` | Dict[str, *Any*] | ➖ | N/A | -| `nvidia` | Dict[str, *Any*] | ➖ | N/A | -| `octoai` | Dict[str, *Any*] | ➖ | N/A | -| `ollama` | Dict[str, *Any*] | ➖ | N/A | -| `open_inference` | Dict[str, *Any*] | ➖ | N/A | -| `openai` | Dict[str, *Any*] | ➖ | N/A | -| `parasail` | Dict[str, *Any*] | ➖ | N/A | -| `perceptron` | Dict[str, *Any*] | ➖ | N/A | -| `perplexity` | Dict[str, *Any*] | ➖ | N/A | -| `phala` | Dict[str, *Any*] | ➖ | N/A | -| `poolside` | Dict[str, *Any*] | ➖ | N/A | -| `primeintellect` | Dict[str, *Any*] | ➖ | N/A | -| `quiver` | Dict[str, *Any*] | ➖ | N/A | -| `recraft` | Dict[str, *Any*] | ➖ | N/A | -| `recursal` | Dict[str, *Any*] | ➖ | N/A | -| `reflection` | Dict[str, *Any*] | ➖ | N/A | -| `reka` | Dict[str, *Any*] | ➖ | N/A | -| `relace` | Dict[str, *Any*] | ➖ | N/A | -| `replicate` | Dict[str, *Any*] | ➖ | N/A | -| `respan` | Dict[str, *Any*] | ➖ | N/A | -| `runway` | Dict[str, *Any*] | ➖ | N/A | -| `sail_research` | Dict[str, *Any*] | ➖ | N/A | -| `sakana` | Dict[str, *Any*] | ➖ | N/A | -| `sakana_ai` | Dict[str, *Any*] | ➖ | N/A | -| `sambanova` | Dict[str, *Any*] | ➖ | N/A | -| `sambanova_cloaked` | Dict[str, *Any*] | ➖ | N/A | -| `scaledown` | Dict[str, *Any*] | ➖ | N/A | -| `seed` | Dict[str, *Any*] | ➖ | N/A | -| `sf_compute` | Dict[str, *Any*] | ➖ | N/A | -| `siliconflow` | Dict[str, *Any*] | ➖ | N/A | -| `sourceful` | Dict[str, *Any*] | ➖ | N/A | -| `stealth` | Dict[str, *Any*] | ➖ | N/A | -| `stepfun` | Dict[str, *Any*] | ➖ | N/A | -| `streamlake` | Dict[str, *Any*] | ➖ | N/A | -| `switchpoint` | Dict[str, *Any*] | ➖ | N/A | -| `targon` | Dict[str, *Any*] | ➖ | N/A | -| `tencent` | Dict[str, *Any*] | ➖ | N/A | -| `tenstorrent` | Dict[str, *Any*] | ➖ | N/A | -| `thinkingmachines` | Dict[str, *Any*] | ➖ | N/A | -| `together` | Dict[str, *Any*] | ➖ | N/A | -| `together_lite` | Dict[str, *Any*] | ➖ | N/A | -| `typesafe` | Dict[str, *Any*] | ➖ | N/A | -| `ubicloud` | Dict[str, *Any*] | ➖ | N/A | -| `unbiased` | Dict[str, *Any*] | ➖ | N/A | -| `upstage` | Dict[str, *Any*] | ➖ | N/A | -| `venice` | Dict[str, *Any*] | ➖ | N/A | -| `voyageai` | Dict[str, *Any*] | ➖ | N/A | -| `wafer` | Dict[str, *Any*] | ➖ | N/A | -| `wandb` | Dict[str, *Any*] | ➖ | N/A | -| `wandb_legacy` | Dict[str, *Any*] | ➖ | N/A | -| `xai` | Dict[str, *Any*] | ➖ | N/A | -| `xiaomi` | Dict[str, *Any*] | ➖ | N/A | -| `z_ai` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file +| `oneai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ai21` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `aion_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `akashml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `alibaba` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `amazon_bedrock` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `amazon_nova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ambient` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `anthropic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `anthropic_2` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `anyscale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `arcee_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `assemblyai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `atlas_cloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `atoma` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `avian` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `azure` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `baidu` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `baseten` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `black_forest_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `byteplus` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `centml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cerebras` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `chutes` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cirrascale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `clarifai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cloudflare` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cohere` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `coreweave` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `cosine` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `crofai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `crucible` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `crusoe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `darkbloom` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `databricks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `decart` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deepgram` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deepinfra` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deepseek` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `dekallm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `digitalocean` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `elevenlabs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `enfer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fake_provider` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `featherless` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fireworks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fish_audio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `friendli` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `gmicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `google_ai_studio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `google_vertex` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `gopomelo` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `groq` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `heygen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `huggingface` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `hyperbolic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `hyperbolic_quantized` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inception` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inferact_vllm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inference_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `infermatic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `inocloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `io_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ionstream` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `klusterai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `krea` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lambda_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lepton` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `liquid` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lynn` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `lynn_private` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `makora` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mancer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mancer_old` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mara` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `meta` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `minimax` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mistral` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `modal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `modelrun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `modular` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `moonshotai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `morph` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ncompass` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `near_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nebius` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nex_agi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nextbit` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nineteen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `novita` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `nvidia` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `octoai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ollama` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `open_inference` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `openai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `parasail` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `perceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `perplexity` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `phala` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `poolside` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `primeintellect` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `quiver` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `recraft` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `recursal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `reflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `reka` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `relace` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `replicate` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `respan` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `runway` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sail_research` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sakana` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sakana_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sambanova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sambanova_cloaked` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `scaledown` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `seed` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sf_compute` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `siliconflow` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `sourceful` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `stealth` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `stepfun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `streamlake` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `switchpoint` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `targon` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `tencent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `tenstorrent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `thinkingmachines` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `together` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `together_lite` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `typesafe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `ubicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `unbiased` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `upstage` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `venice` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `voyageai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `wafer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `wandb` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `wandb_legacy` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `xai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `xiaomi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `z_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/videogenerationrequestprovider.mdx b/docs/components/videogenerationrequestprovider.mdx index 7fc69a9d5..63d009579 100644 --- a/docs/components/videogenerationrequestprovider.mdx +++ b/docs/components/videogenerationrequestprovider.mdx @@ -9,4 +9,4 @@ Provider-specific passthrough configuration | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `options` | [Optional[components.VideoGenerationRequestOptions]](../components/videogenerationrequestoptions.mdx) | ➖ | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file +| `options` | [Optional[components.VideoGenerationRequestOptions]](../components/videogenerationrequestoptions.mdx) | :heavy_minus_sign: | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file diff --git a/docs/components/videogenerationresponse.mdx b/docs/components/videogenerationresponse.mdx index c73f8bd2d..ac588d7de 100644 --- a/docs/components/videogenerationresponse.mdx +++ b/docs/components/videogenerationresponse.mdx @@ -6,11 +6,11 @@ title: "VideoGenerationResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `error` | *Optional[str]* | ➖ | N/A | | -| `expires_at` | *Optional[int]* | ➖ | Unix timestamp in seconds when OpenRouter's stored copy of the outputs stops being available. Present only when that copy exists. | | -| `generation_id` | *Optional[str]* | ➖ | The generation ID associated with this video generation job. Available once the job has been processed. | | -| `id` | *str* | ✅ | The video job ID, in the `gen-vid--<20 alphanumerics>` generation ID format. Pass it as `previous_job_id` to continue the generation. | | -| `polling_url` | *str* | ✅ | N/A | | -| `status` | [components.VideoGenerationResponseStatus](../components/videogenerationresponsestatus.mdx) | ✅ | N/A | | -| `unsigned_urls` | List[*str*] | ➖ | N/A | | -| `usage` | [Optional[components.VideoGenerationUsage]](../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `expires_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp in seconds when OpenRouter's stored copy of the outputs stops being available. Present only when that copy exists. | | +| `generation_id` | *Optional[str]* | :heavy_minus_sign: | The generation ID associated with this video generation job. Available once the job has been processed. | | +| `id` | *str* | :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. | | +| `polling_url` | *str* | :heavy_check_mark: | N/A | | +| `status` | [components.VideoGenerationResponseStatus](../components/videogenerationresponsestatus.mdx) | :heavy_check_mark: | N/A | | +| `unsigned_urls` | List[*str*] | :heavy_minus_sign: | N/A | | +| `usage` | [Optional[components.VideoGenerationUsage]](../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/components/videogenerationusage.mdx b/docs/components/videogenerationusage.mdx index cc366e2b1..191665906 100644 --- a/docs/components/videogenerationusage.mdx +++ b/docs/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[float]* | ➖ | The cost of the video generation in USD. | -| `is_byok` | *Optional[bool]* | ➖ | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file +| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | The cost of the video generation in USD. | +| `is_byok` | *Optional[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/components/videomodel.mdx b/docs/components/videomodel.mdx index 37ead2bb7..ebe922ee8 100644 --- a/docs/components/videomodel.mdx +++ b/docs/components/videomodel.mdx @@ -6,20 +6,20 @@ title: "VideoModel" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `allowed_passthrough_parameters` | List[*str*] | ✅ | List of parameters that are allowed to be passed through to the provider | | -| `canonical_slug` | *str* | ✅ | Canonical slug for the model | openai/gpt-4 | -| `created` | *int* | ✅ | Unix timestamp of when the model was created | 1692901234 | -| `creativity` | List[*int*] | ✅ | Supported creativity levels for video upscaling models | | -| `description` | *Optional[str]* | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `generate_audio` | *Nullable[bool]* | ✅ | Whether the model supports generating audio alongside video | | -| `hugging_face_id` | *OptionalNullable[str]* | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *str* | ✅ | Unique identifier for the model | openai/gpt-4 | -| `name` | *str* | ✅ | Display name of the model | GPT-4 | -| `pricing_skus` | Dict[str, *str*] | ➖ | Pricing SKUs with provider prefix stripped, values as strings | | -| `seed` | *Nullable[bool]* | ✅ | Whether the model supports deterministic generation via seed parameter | | -| `supported_aspect_ratios` | List[[components.SupportedAspectRatio](../components/supportedaspectratio.mdx)] | ✅ | Supported output aspect ratios | | -| `supported_durations` | List[*int*] | ✅ | Supported video durations in seconds | | -| `supported_frame_images` | List[[components.SupportedFrameImage](../components/supportedframeimage.mdx)] | ✅ | Supported frame image types (e.g. first_frame, last_frame) | | -| `supported_resolutions` | List[[components.SupportedResolution](../components/supportedresolution.mdx)] | ✅ | Supported output resolutions | | -| `supported_sizes` | List[[components.SupportedSize](../components/supportedsize.mdx)] | ✅ | Supported output sizes (width x height) | | -| `upscale_factor` | [Nullable[components.UpscaleFactor]](../components/upscalefactor.mdx) | ✅ | Supported upscale factor range for video upscaling models | | \ No newline at end of file +| `allowed_passthrough_parameters` | List[*str*] | :heavy_check_mark: | List of parameters that are allowed to be passed through to the provider | | +| `canonical_slug` | *str* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | +| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | +| `creativity` | List[*int*] | :heavy_check_mark: | Supported creativity levels for video upscaling models | | +| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `generate_audio` | *Nullable[bool]* | :heavy_check_mark: | Whether the model supports generating audio alongside video | | +| `hugging_face_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | +| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | +| `pricing_skus` | Dict[str, *str*] | :heavy_minus_sign: | Pricing SKUs with provider prefix stripped, values as strings | | +| `seed` | *Nullable[bool]* | :heavy_check_mark: | Whether the model supports deterministic generation via seed parameter | | +| `supported_aspect_ratios` | List[[components.SupportedAspectRatio](../components/supportedaspectratio.mdx)] | :heavy_check_mark: | Supported output aspect ratios | | +| `supported_durations` | List[*int*] | :heavy_check_mark: | Supported video durations in seconds | | +| `supported_frame_images` | List[[components.SupportedFrameImage](../components/supportedframeimage.mdx)] | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | +| `supported_resolutions` | List[[components.SupportedResolution](../components/supportedresolution.mdx)] | :heavy_check_mark: | Supported output resolutions | | +| `supported_sizes` | List[[components.SupportedSize](../components/supportedsize.mdx)] | :heavy_check_mark: | Supported output sizes (width x height) | | +| `upscale_factor` | [Nullable[components.UpscaleFactor]](../components/upscalefactor.mdx) | :heavy_check_mark: | Supported upscale factor range for video upscaling models | | \ No newline at end of file diff --git a/docs/components/videomodelslistresponse.mdx b/docs/components/videomodelslistresponse.mdx index 5e4643eec..9199c3b3d 100644 --- a/docs/components/videomodelslistresponse.mdx +++ b/docs/components/videomodelslistresponse.mdx @@ -6,4 +6,4 @@ title: "VideoModelsListResponse" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data` | List[[components.VideoModel](../components/videomodel.mdx)] | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.VideoModel](../components/videomodel.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/videourl.mdx b/docs/components/videourl.mdx index 334e57e27..7cbbaeaa0 100644 --- a/docs/components/videourl.mdx +++ b/docs/components/videourl.mdx @@ -6,4 +6,4 @@ title: "VideoURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/webfetchplugin.mdx b/docs/components/webfetchplugin.mdx index d4d69a4e7..f46512871 100644 --- a/docs/components/webfetchplugin.mdx +++ b/docs/components/webfetchplugin.mdx @@ -6,8 +6,8 @@ title: "WebFetchPlugin" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | ➖ | Only fetch from these domains. | -| `blocked_domains` | List[*str*] | ➖ | Never fetch from these domains. | -| `id` | [components.WebFetchPluginID](../components/webfetchpluginid.mdx) | ✅ | N/A | -| `max_content_tokens` | *Optional[int]* | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | -| `max_uses` | *Optional[int]* | ➖ | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file +| `allowed_domains` | List[*str*] | :heavy_minus_sign: | Only fetch from these domains. | +| `blocked_domains` | List[*str*] | :heavy_minus_sign: | Never fetch from these domains. | +| `id` | [components.WebFetchPluginID](../components/webfetchpluginid.mdx) | :heavy_check_mark: | N/A | +| `max_content_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | +| `max_uses` | *Optional[int]* | :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/components/webfetchservertool.mdx b/docs/components/webfetchservertool.mdx index 7e817ae82..fe93938c6 100644 --- a/docs/components/webfetchservertool.mdx +++ b/docs/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` | [Optional[components.WebFetchServerToolConfig]](../components/webfetchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | -| `type` | [components.WebFetchServerToolType](../components/webfetchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.WebFetchServerToolConfig]](../components/webfetchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | +| `type` | [components.WebFetchServerToolType](../components/webfetchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/webfetchservertoolconfig.mdx b/docs/components/webfetchservertoolconfig.mdx index 368d24755..1d52d81ac 100644 --- a/docs/components/webfetchservertoolconfig.mdx +++ b/docs/components/webfetchservertoolconfig.mdx @@ -9,8 +9,8 @@ Configuration for the openrouter:web_fetch server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | ➖ | Only fetch from these domains. | | -| `blocked_domains` | List[*str*] | ➖ | Never fetch from these domains. | | -| `engine` | [Optional[components.WebFetchEngineEnum]](../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 | -| `max_content_tokens` | *Optional[int]* | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | -| `max_uses` | *Optional[int]* | ➖ | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file +| `allowed_domains` | List[*str*] | :heavy_minus_sign: | Only fetch from these domains. | | +| `blocked_domains` | List[*str*] | :heavy_minus_sign: | Never fetch from these domains. | | +| `engine` | [Optional[components.WebFetchEngineEnum]](../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 | +| `max_content_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | +| `max_uses` | *Optional[int]* | :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/components/websearchcallcompletedevent.mdx b/docs/components/websearchcallcompletedevent.mdx index 61fa977f3..34bcc1fe4 100644 --- a/docs/components/websearchcallcompletedevent.mdx +++ b/docs/components/websearchcallcompletedevent.mdx @@ -9,7 +9,7 @@ Web search call completed | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.WebSearchCallCompletedEventType](../components/websearchcallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.WebSearchCallCompletedEventType](../components/websearchcallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/websearchcallinprogressevent.mdx b/docs/components/websearchcallinprogressevent.mdx index f0d552ca8..eaf3e6060 100644 --- a/docs/components/websearchcallinprogressevent.mdx +++ b/docs/components/websearchcallinprogressevent.mdx @@ -9,7 +9,7 @@ Web search call in progress | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.WebSearchCallInProgressEventType](../components/websearchcallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.WebSearchCallInProgressEventType](../components/websearchcallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/websearchcallsearchingevent.mdx b/docs/components/websearchcallsearchingevent.mdx index 2a4da1904..5cd281053 100644 --- a/docs/components/websearchcallsearchingevent.mdx +++ b/docs/components/websearchcallsearchingevent.mdx @@ -9,7 +9,7 @@ Web search call is searching | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | ✅ | N/A | -| `output_index` | *int* | ✅ | N/A | -| `sequence_number` | *int* | ✅ | N/A | -| `type` | [components.WebSearchCallSearchingEventType](../components/websearchcallsearchingeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `item_id` | *str* | :heavy_check_mark: | N/A | +| `output_index` | *int* | :heavy_check_mark: | N/A | +| `sequence_number` | *int* | :heavy_check_mark: | N/A | +| `type` | [components.WebSearchCallSearchingEventType](../components/websearchcallsearchingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/websearchcitation.mdx b/docs/components/websearchcitation.mdx index a0faca26c..c95316353 100644 --- a/docs/components/websearchcitation.mdx +++ b/docs/components/websearchcitation.mdx @@ -6,7 +6,7 @@ title: "WebSearchCitation" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `cited_text` | *Optional[str]* | ➖ | N/A | -| `encrypted_index` | *Optional[str]* | ➖ | N/A | -| `title` | *Nullable[str]* | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `cited_text` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `encrypted_index` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/websearchconfig.mdx b/docs/components/websearchconfig.mdx index cdfd73106..b7671cf8a 100644 --- a/docs/components/websearchconfig.mdx +++ b/docs/components/websearchconfig.mdx @@ -6,14 +6,14 @@ title: "WebSearchConfig" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | ➖ | 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` | [Optional[components.WebSearchEngineEnum]](../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 | -| `excluded_domains` | List[*str*] | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `max_characters` | *Optional[int]* | ➖ | 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 | -| `max_results` | *Optional[int]* | ➖ | 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 | -| `max_total_results` | *Optional[int]* | ➖ | 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 | -| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchQualityLevel]](../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 | -| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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 +| `allowed_domains` | List[*str*] | :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` | [Optional[components.WebSearchEngineEnum]](../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 | +| `excluded_domains` | List[*str*] | :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. | | +| `max_characters` | *Optional[int]* | :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 | +| `max_results` | *Optional[int]* | :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 | +| `max_total_results` | *Optional[int]* | :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 | +| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchQualityLevel]](../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 | +| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../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"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/websearchdomainfilter.mdx b/docs/components/websearchdomainfilter.mdx index 75b7b15dd..de20da275 100644 --- a/docs/components/websearchdomainfilter.mdx +++ b/docs/components/websearchdomainfilter.mdx @@ -6,6 +6,6 @@ title: "WebSearchDomainFilter" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `allowed_domains` | List[*str*] | ➖ | N/A | -| `blocked_domains` | List[*str*] | ➖ | N/A | -| `excluded_domains` | List[*str*] | ➖ | N/A | \ No newline at end of file +| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | +| `blocked_domains` | List[*str*] | :heavy_minus_sign: | N/A | +| `excluded_domains` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/websearchplugin.mdx b/docs/components/websearchplugin.mdx index 8ef5667f5..6cd0c9a77 100644 --- a/docs/components/websearchplugin.mdx +++ b/docs/components/websearchplugin.mdx @@ -6,14 +6,14 @@ title: "WebSearchPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `enabled` | *Optional[bool]* | ➖ | Set to false to disable the web-search plugin for this request. Defaults to true. | | -| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.mdx) | ➖ | The search engine to use for web search. | exa | -| `exclude_domains` | List[*str*] | ➖ | 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](../components/websearchpluginid.mdx) | ✅ | N/A | | -| `include_domains` | List[*str*] | ➖ | 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"
] | -| `max_results` | *Optional[int]* | ➖ | N/A | | -| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | -| `search_prompt` | *Optional[str]* | ➖ | N/A | | -| `user_location` | [OptionalNullable[components.UserLocation]](../components/userlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | +| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.mdx) | :heavy_minus_sign: | The search engine to use for web search. | exa | +| `exclude_domains` | List[*str*] | :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](../components/websearchpluginid.mdx) | :heavy_check_mark: | N/A | | +| `include_domains` | List[*str*] | :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"
] | +| `max_results` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | +| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `user_location` | [OptionalNullable[components.UserLocation]](../components/userlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/websearchservertool.mdx b/docs/components/websearchservertool.mdx index 6b93c896c..4a66fcbb5 100644 --- a/docs/components/websearchservertool.mdx +++ b/docs/components/websearchservertool.mdx @@ -9,12 +9,12 @@ Web search tool configuration (2025-08-26 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `max_results` | *Optional[int]* | ➖ | 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 | -| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | -| `type` | [components.WebSearchServerToolType](../components/websearchservertooltype.mdx) | ✅ | N/A | | -| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../components/websearchuserlocation.mdx) | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `max_results` | *Optional[int]* | :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 | +| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `type` | [components.WebSearchServerToolType](../components/websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | +| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../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"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/websearchservertoolconfig.mdx b/docs/components/websearchservertoolconfig.mdx index 832dce858..206799c77 100644 --- a/docs/components/websearchservertoolconfig.mdx +++ b/docs/components/websearchservertoolconfig.mdx @@ -9,14 +9,14 @@ Configuration for the openrouter:web_search server tool | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | ➖ | 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` | [Optional[components.WebSearchEngineEnum]](../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 | -| `excluded_domains` | List[*str*] | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `max_characters` | *Optional[int]* | ➖ | 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 | -| `max_results` | *Optional[int]* | ➖ | 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 | -| `max_total_results` | *Optional[int]* | ➖ | 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 | -| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchQualityLevel]](../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 | -| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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 +| `allowed_domains` | List[*str*] | :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` | [Optional[components.WebSearchEngineEnum]](../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 | +| `excluded_domains` | List[*str*] | :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. | | +| `max_characters` | *Optional[int]* | :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 | +| `max_results` | *Optional[int]* | :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 | +| `max_total_results` | *Optional[int]* | :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 | +| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchQualityLevel]](../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 | +| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../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"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/websearchservertoolopenrouter.mdx b/docs/components/websearchservertoolopenrouter.mdx index 5c7db3ebf..1e3301d31 100644 --- a/docs/components/websearchservertoolopenrouter.mdx +++ b/docs/components/websearchservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.WebSearchServerToolConfig]](../components/websearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `type` | [components.WebSearchServerToolOpenRouterType](../components/websearchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.WebSearchServerToolConfig]](../components/websearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `type` | [components.WebSearchServerToolOpenRouterType](../components/websearchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/components/websearchsource.mdx b/docs/components/websearchsource.mdx index 35bdea156..870075f95 100644 --- a/docs/components/websearchsource.mdx +++ b/docs/components/websearchsource.mdx @@ -6,5 +6,5 @@ title: "WebSearchSource" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.WebSearchSourceType](../components/websearchsourcetype.mdx) | ✅ | N/A | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `type` | [components.WebSearchSourceType](../components/websearchsourcetype.mdx) | :heavy_check_mark: | N/A | +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/components/websearchuserlocation.mdx b/docs/components/websearchuserlocation.mdx index 1c3895f5e..dccb9d9a1 100644 --- a/docs/components/websearchuserlocation.mdx +++ b/docs/components/websearchuserlocation.mdx @@ -9,8 +9,8 @@ User location information for web search | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `city` | *OptionalNullable[str]* | ➖ | N/A | -| `country` | *OptionalNullable[str]* | ➖ | N/A | -| `region` | *OptionalNullable[str]* | ➖ | N/A | -| `timezone` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [Optional[components.WebSearchUserLocationType]](../components/websearchuserlocationtype.mdx) | ➖ | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[components.WebSearchUserLocationType]](../components/websearchuserlocationtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/websearchuserlocationservertool.mdx b/docs/components/websearchuserlocationservertool.mdx index 1bd2f8c6e..98a2e0b60 100644 --- a/docs/components/websearchuserlocationservertool.mdx +++ b/docs/components/websearchuserlocationservertool.mdx @@ -9,8 +9,8 @@ Approximate user location for location-biased results. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `city` | *OptionalNullable[str]* | ➖ | N/A | -| `country` | *OptionalNullable[str]* | ➖ | N/A | -| `region` | *OptionalNullable[str]* | ➖ | N/A | -| `timezone` | *OptionalNullable[str]* | ➖ | N/A | -| `type` | [Optional[components.WebSearchUserLocationServerToolType]](../components/websearchuserlocationservertooltype.mdx) | ➖ | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[components.WebSearchUserLocationServerToolType]](../components/websearchuserlocationservertooltype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/components/workspace.mdx b/docs/components/workspace.mdx index fff268dd0..e3866ea05 100644 --- a/docs/components/workspace.mdx +++ b/docs/components/workspace.mdx @@ -6,21 +6,21 @@ title: "Workspace" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | -| `created_by` | *Nullable[str]* | ✅ | User ID of the workspace creator | user_abc123 | -| `default_guardrail_id` | *str* | ✅ | Deterministic ID derived from the workspace ID. The default guardrail is materialized when its configuration is first written. | 595d5849-7e86-51fd-a7c0-705c34e4afff | -| `default_image_model` | *Nullable[str]* | ✅ | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *Nullable[str]* | ✅ | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *Nullable[str]* | ✅ | Default text model for this workspace | openai/gpt-4o | -| `description` | *Nullable[str]* | ✅ | Description of the workspace | Production environment workspace | -| `disabled_server_tools` | List[*str*] | ➖ | OpenRouter server tools (e.g. openrouter:web_search) that requests in this workspace may not invoke. Null means no tools are disabled. | null | -| `id` | *str* | ✅ | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | -| `include_byok_in_budgets` | *Optional[bool]* | ➖ | Whether BYOK (bring-your-own-key) spend counts toward this workspace's budgets. Set it via the workspace budget endpoints. | false | -| `io_logging_api_key_ids` | List[*int*] | ✅ | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | -| `io_logging_sampling_rate` | *float* | ✅ | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | -| `is_data_discount_logging_enabled` | *bool* | ✅ | Whether data discount logging is enabled for this workspace | true | -| `is_observability_broadcast_enabled` | *bool* | ✅ | Whether broadcast is enabled for this workspace | false | -| `is_observability_io_logging_enabled` | *bool* | ✅ | Whether private logging is enabled for this workspace | false | -| `name` | *str* | ✅ | Name of the workspace | Production | -| `slug` | *str* | ✅ | URL-friendly slug for the workspace | production | -| `updated_at` | *Nullable[str]* | ✅ | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | +| `created_by` | *Nullable[str]* | :heavy_check_mark: | User ID of the workspace creator | user_abc123 | +| `default_guardrail_id` | *str* | :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 | +| `default_image_model` | *Nullable[str]* | :heavy_check_mark: | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *Nullable[str]* | :heavy_check_mark: | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *Nullable[str]* | :heavy_check_mark: | Default text model for this workspace | openai/gpt-4o | +| `description` | *Nullable[str]* | :heavy_check_mark: | Description of the workspace | Production environment workspace | +| `disabled_server_tools` | List[*str*] | :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` | *str* | :heavy_check_mark: | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | +| `include_byok_in_budgets` | *Optional[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 | +| `io_logging_api_key_ids` | List[*int*] | :heavy_check_mark: | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | +| `io_logging_sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | +| `is_data_discount_logging_enabled` | *bool* | :heavy_check_mark: | Whether data discount logging is enabled for this workspace | true | +| `is_observability_broadcast_enabled` | *bool* | :heavy_check_mark: | Whether broadcast is enabled for this workspace | false | +| `is_observability_io_logging_enabled` | *bool* | :heavy_check_mark: | Whether private logging is enabled for this workspace | false | +| `name` | *str* | :heavy_check_mark: | Name of the workspace | Production | +| `slug` | *str* | :heavy_check_mark: | URL-friendly slug for the workspace | production | +| `updated_at` | *Nullable[str]* | :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/components/workspacebudget.mdx b/docs/components/workspacebudget.mdx index 4dfb369b9..90cef4e9c 100644 --- a/docs/components/workspacebudget.mdx +++ b/docs/components/workspacebudget.mdx @@ -6,9 +6,9 @@ title: "WorkspaceBudget" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | -| `id` | *str* | ✅ | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | -| `limit_usd` | *float* | ✅ | Spending limit in USD for this interval | 100 | -| `reset_interval` | [Nullable[components.WorkspaceBudgetResetInterval]](../components/workspacebudgetresetinterval.mdx) | ✅ | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | -| `updated_at` | *str* | ✅ | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | ✅ | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | +| `limit_usd` | *float* | :heavy_check_mark: | Spending limit in USD for this interval | 100 | +| `reset_interval` | [Nullable[components.WorkspaceBudgetResetInterval]](../components/workspacebudgetresetinterval.mdx) | :heavy_check_mark: | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | +| `updated_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | :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/components/workspacemember.mdx b/docs/components/workspacemember.mdx index 48ec5c899..3e77b3d51 100644 --- a/docs/components/workspacemember.mdx +++ b/docs/components/workspacemember.mdx @@ -6,8 +6,8 @@ title: "WorkspaceMember" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | -| `id` | *str* | ✅ | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | -| `role` | [components.WorkspaceMemberRole](../components/workspacememberrole.mdx) | ✅ | Role of the member in the workspace | member | -| `user_id` | *str* | ✅ | Clerk user ID of the member | user_abc123 | -| `workspace_id` | *str* | ✅ | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | +| `role` | [components.WorkspaceMemberRole](../components/workspacememberrole.mdx) | :heavy_check_mark: | Role of the member in the workspace | member | +| `user_id` | *str* | :heavy_check_mark: | Clerk user ID of the member | user_abc123 | +| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/xsearchoptions.mdx b/docs/components/xsearchoptions.mdx index 07f069752..d742b5c2b 100644 --- a/docs/components/xsearchoptions.mdx +++ b/docs/components/xsearchoptions.mdx @@ -9,9 +9,9 @@ Enable SpaceXAI X (Twitter) search alongside native web search, with optional fi | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `allowed_x_handles` | List[*str*] | ➖ | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | -| `enable_image_understanding` | *Optional[bool]* | ➖ | Analyze images attached to matching posts. | | -| `enable_video_understanding` | *Optional[bool]* | ➖ | Analyze videos attached to matching posts. | | -| `excluded_x_handles` | List[*str*] | ➖ | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | -| `from_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | ➖ | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | -| `to_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | ➖ | End of the post date range (ISO 8601 date, e.g. "2025-12-31"). | 2025-12-31 | \ No newline at end of file +| `allowed_x_handles` | List[*str*] | :heavy_minus_sign: | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | +| `enable_image_understanding` | *Optional[bool]* | :heavy_minus_sign: | Analyze images attached to matching posts. | | +| `enable_video_understanding` | *Optional[bool]* | :heavy_minus_sign: | Analyze videos attached to matching posts. | | +| `excluded_x_handles` | List[*str*] | :heavy_minus_sign: | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | +| `from_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | +| `to_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :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/errors/badgatewayresponseerror.mdx b/docs/errors/badgatewayresponseerror.mdx index 0a1a19d0b..d596a9c0e 100644 --- a/docs/errors/badgatewayresponseerror.mdx +++ b/docs/errors/badgatewayresponseerror.mdx @@ -9,6 +9,6 @@ Bad Gateway - Provider/upstream API failure | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `error` | [components.BadGatewayResponseErrorData](../components/badgatewayresponseerrordata.mdx) | ✅ | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.BadGatewayResponseErrorData](../components/badgatewayresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/badrequestresponseerror.mdx b/docs/errors/badrequestresponseerror.mdx index 7d8daf0cd..68e67bcf8 100644 --- a/docs/errors/badrequestresponseerror.mdx +++ b/docs/errors/badrequestresponseerror.mdx @@ -9,6 +9,6 @@ Bad Request - Invalid request parameters or malformed input | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `error` | [components.BadRequestResponseErrorData](../components/badrequestresponseerrordata.mdx) | ✅ | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.BadRequestResponseErrorData](../components/badrequestresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/batcherrorresponse.mdx b/docs/errors/batcherrorresponse.mdx index 049632f96..6b8ce49bb 100644 --- a/docs/errors/batcherrorresponse.mdx +++ b/docs/errors/batcherrorresponse.mdx @@ -6,4 +6,4 @@ title: "BatchErrorResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `error` | [components.BatchErrorResponseError](../components/batcherrorresponseerror.mdx) | ✅ | N/A | \ No newline at end of file +| `error` | [components.BatchErrorResponseError](../components/batcherrorresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/errors/batchpaymentrequiredresponseerror.mdx b/docs/errors/batchpaymentrequiredresponseerror.mdx index ce0175950..9c093bb2b 100644 --- a/docs/errors/batchpaymentrequiredresponseerror.mdx +++ b/docs/errors/batchpaymentrequiredresponseerror.mdx @@ -9,15 +9,15 @@ Batch metadata with results withheld (results: null) plus the standard error env | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `completion_window` | [components.BatchPaymentRequiredResponseCompletionWindow](../components/batchpaymentrequiredresponsecompletionwindow.mdx) | ✅ | N/A | -| `created_at` | *int* | ✅ | N/A | -| `endpoint` | *str* | ✅ | N/A | -| `error` | [components.BatchPaymentRequiredResponseError](../components/batchpaymentrequiredresponseerror.mdx) | ✅ | N/A | -| `finalized_at` | *Nullable[int]* | ✅ | N/A | -| `id` | *str* | ✅ | N/A | -| `model` | *str* | ✅ | N/A | -| `object` | [components.BatchPaymentRequiredResponseObject](../components/batchpaymentrequiredresponseobject.mdx) | ✅ | N/A | -| `request_counts` | [components.BatchPaymentRequiredResponseRequestCounts](../components/batchpaymentrequiredresponserequestcounts.mdx) | ✅ | N/A | -| `results` | *Nullable[Any]* | ✅ | Always null: results are withheld until the batch charge is covered. | -| `status` | [components.BatchPaymentRequiredResponseStatus](../components/batchpaymentrequiredresponsestatus.mdx) | ✅ | N/A | -| `usage` | [Nullable[components.BatchPaymentRequiredResponseUsage]](../components/batchpaymentrequiredresponseusage.mdx) | ✅ | N/A | \ No newline at end of file +| `completion_window` | [components.BatchPaymentRequiredResponseCompletionWindow](../components/batchpaymentrequiredresponsecompletionwindow.mdx) | :heavy_check_mark: | N/A | +| `created_at` | *int* | :heavy_check_mark: | N/A | +| `endpoint` | *str* | :heavy_check_mark: | N/A | +| `error` | [components.BatchPaymentRequiredResponseError](../components/batchpaymentrequiredresponseerror.mdx) | :heavy_check_mark: | N/A | +| `finalized_at` | *Nullable[int]* | :heavy_check_mark: | N/A | +| `id` | *str* | :heavy_check_mark: | N/A | +| `model` | *str* | :heavy_check_mark: | N/A | +| `object` | [components.BatchPaymentRequiredResponseObject](../components/batchpaymentrequiredresponseobject.mdx) | :heavy_check_mark: | N/A | +| `request_counts` | [components.BatchPaymentRequiredResponseRequestCounts](../components/batchpaymentrequiredresponserequestcounts.mdx) | :heavy_check_mark: | N/A | +| `results` | *Nullable[Any]* | :heavy_check_mark: | Always null: results are withheld until the batch charge is covered. | +| `status` | [components.BatchPaymentRequiredResponseStatus](../components/batchpaymentrequiredresponsestatus.mdx) | :heavy_check_mark: | N/A | +| `usage` | [Nullable[components.BatchPaymentRequiredResponseUsage]](../components/batchpaymentrequiredresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/errors/conflictresponseerror.mdx b/docs/errors/conflictresponseerror.mdx index f496472b8..c6f96de88 100644 --- a/docs/errors/conflictresponseerror.mdx +++ b/docs/errors/conflictresponseerror.mdx @@ -9,6 +9,6 @@ Conflict - Resource conflict or concurrent modification | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [components.ConflictResponseErrorData](../components/conflictresponseerrordata.mdx) | ✅ | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.ConflictResponseErrorData](../components/conflictresponseerrordata.mdx) | :heavy_check_mark: | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/createprivateendpointvalidationfailedresponseerror.mdx b/docs/errors/createprivateendpointvalidationfailedresponseerror.mdx index 432d5a57a..4c63b4d5b 100644 --- a/docs/errors/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/errors/createprivateendpointvalidationfailedresponseerror.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.CreatePrivateEndpointValidationFailedResponseData](../components/createprivateendpointvalidationfailedresponsedata.mdx) | ✅ | N/A | -| `error` | [components.CreatePrivateEndpointValidationFailedResponseError](../components/createprivateendpointvalidationfailedresponseerror.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [components.CreatePrivateEndpointValidationFailedResponseData](../components/createprivateendpointvalidationfailedresponsedata.mdx) | :heavy_check_mark: | N/A | +| `error` | [components.CreatePrivateEndpointValidationFailedResponseError](../components/createprivateendpointvalidationfailedresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/errors/edgenetworktimeoutresponseerror.mdx b/docs/errors/edgenetworktimeoutresponseerror.mdx index 6ddc69ad9..845c9d6c0 100644 --- a/docs/errors/edgenetworktimeoutresponseerror.mdx +++ b/docs/errors/edgenetworktimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Infrastructure Timeout - Provider request timed out at edge network | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.EdgeNetworkTimeoutResponseErrorData](../components/edgenetworktimeoutresponseerrordata.mdx) | ✅ | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.EdgeNetworkTimeoutResponseErrorData](../components/edgenetworktimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/forbiddenresponseerror.mdx b/docs/errors/forbiddenresponseerror.mdx index 468d326ba..657b79d00 100644 --- a/docs/errors/forbiddenresponseerror.mdx +++ b/docs/errors/forbiddenresponseerror.mdx @@ -9,6 +9,6 @@ Forbidden - Authentication successful but insufficient permissions | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `error` | [components.ForbiddenResponseErrorData](../components/forbiddenresponseerrordata.mdx) | ✅ | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.ForbiddenResponseErrorData](../components/forbiddenresponseerrordata.mdx) | :heavy_check_mark: | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/gatewaytimeoutresponseerror.mdx b/docs/errors/gatewaytimeoutresponseerror.mdx index 20530f230..b16b713f2 100644 --- a/docs/errors/gatewaytimeoutresponseerror.mdx +++ b/docs/errors/gatewaytimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Gateway Timeout - Provider did not respond before the upstream deadline | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.GatewayTimeoutResponseErrorData](../components/gatewaytimeoutresponseerrordata.mdx) | ✅ | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.GatewayTimeoutResponseErrorData](../components/gatewaytimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/goneresponseerror.mdx b/docs/errors/goneresponseerror.mdx index 7df81cbac..3584e71b6 100644 --- a/docs/errors/goneresponseerror.mdx +++ b/docs/errors/goneresponseerror.mdx @@ -9,6 +9,6 @@ Gone - Endpoint has been permanently removed or deprecated | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | [components.GoneResponseErrorData](../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."
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.GoneResponseErrorData](../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."
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/internalserverresponseerror.mdx b/docs/errors/internalserverresponseerror.mdx index 239d837f8..2a892b08d 100644 --- a/docs/errors/internalserverresponseerror.mdx +++ b/docs/errors/internalserverresponseerror.mdx @@ -9,6 +9,6 @@ Internal Server Error - Unexpected server error | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.InternalServerResponseErrorData](../components/internalserverresponseerrordata.mdx) | ✅ | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.InternalServerResponseErrorData](../components/internalserverresponseerrordata.mdx) | :heavy_check_mark: | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/internchaterrorresponse.mdx b/docs/errors/internchaterrorresponse.mdx index 876c46af4..ec1c162ec 100644 --- a/docs/errors/internchaterrorresponse.mdx +++ b/docs/errors/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](../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](../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/errors/internlifecycleerror.mdx b/docs/errors/internlifecycleerror.mdx index 0cdbfafe1..9de3964c0 100644 --- a/docs/errors/internlifecycleerror.mdx +++ b/docs/errors/internlifecycleerror.mdx @@ -9,4 +9,4 @@ Intern lifecycle request failure. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [components.InternLifecycleErrorError](../components/internlifecycleerrorerror.mdx) | ✅ | N/A | \ No newline at end of file +| `error` | [components.InternLifecycleErrorError](../components/internlifecycleerrorerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/errors/notfoundresponseerror.mdx b/docs/errors/notfoundresponseerror.mdx index c4fedfe4a..5ba79a197 100644 --- a/docs/errors/notfoundresponseerror.mdx +++ b/docs/errors/notfoundresponseerror.mdx @@ -9,6 +9,6 @@ Not Found - Resource does not exist | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [components.NotFoundResponseErrorData](../components/notfoundresponseerrordata.mdx) | ✅ | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.NotFoundResponseErrorData](../components/notfoundresponseerrordata.mdx) | :heavy_check_mark: | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/oautherrorresponse.mdx b/docs/errors/oautherrorresponse.mdx index 2190b45c8..9d1631687 100644 --- a/docs/errors/oautherrorresponse.mdx +++ b/docs/errors/oautherrorresponse.mdx @@ -9,5 +9,5 @@ RFC 6749 §5.2 error response. | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `error` | [components.ErrorEnum](../components/errorenum.mdx) | ✅ | N/A | -| `error_description` | *str* | ✅ | N/A | \ No newline at end of file +| `error` | [components.ErrorEnum](../components/errorenum.mdx) | :heavy_check_mark: | N/A | +| `error_description` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/errors/payloadtoolargeresponseerror.mdx b/docs/errors/payloadtoolargeresponseerror.mdx index e232e3a74..ba4d28b0d 100644 --- a/docs/errors/payloadtoolargeresponseerror.mdx +++ b/docs/errors/payloadtoolargeresponseerror.mdx @@ -9,6 +9,6 @@ Payload Too Large - Request payload exceeds size limits | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.PayloadTooLargeResponseErrorData](../components/payloadtoolargeresponseerrordata.mdx) | ✅ | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.PayloadTooLargeResponseErrorData](../components/payloadtoolargeresponseerrordata.mdx) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/paymentrequiredresponseerror.mdx b/docs/errors/paymentrequiredresponseerror.mdx index cde4a1763..f632aa144 100644 --- a/docs/errors/paymentrequiredresponseerror.mdx +++ b/docs/errors/paymentrequiredresponseerror.mdx @@ -9,6 +9,6 @@ Payment Required - Insufficient credits or quota to complete request | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.PaymentRequiredResponseErrorData](../components/paymentrequiredresponseerrordata.mdx) | ✅ | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.PaymentRequiredResponseErrorData](../components/paymentrequiredresponseerrordata.mdx) | :heavy_check_mark: | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/provideroverloadedresponseerror.mdx b/docs/errors/provideroverloadedresponseerror.mdx index 3a024c3b8..c24817c53 100644 --- a/docs/errors/provideroverloadedresponseerror.mdx +++ b/docs/errors/provideroverloadedresponseerror.mdx @@ -9,6 +9,6 @@ Provider Overloaded - Provider is temporarily overloaded | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.ProviderOverloadedResponseErrorData](../components/provideroverloadedresponseerrordata.mdx) | ✅ | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.ProviderOverloadedResponseErrorData](../components/provideroverloadedresponseerrordata.mdx) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/requesttimeoutresponseerror.mdx b/docs/errors/requesttimeoutresponseerror.mdx index 5e35d3b74..81393cc78 100644 --- a/docs/errors/requesttimeoutresponseerror.mdx +++ b/docs/errors/requesttimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Request Timeout - Operation exceeded time limit | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.RequestTimeoutResponseErrorData](../components/requesttimeoutresponseerrordata.mdx) | ✅ | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.RequestTimeoutResponseErrorData](../components/requesttimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/serviceunavailableresponseerror.mdx b/docs/errors/serviceunavailableresponseerror.mdx index 6c51ff54d..102116c63 100644 --- a/docs/errors/serviceunavailableresponseerror.mdx +++ b/docs/errors/serviceunavailableresponseerror.mdx @@ -9,6 +9,6 @@ Service Unavailable - Service temporarily unavailable | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.ServiceUnavailableResponseErrorData](../components/serviceunavailableresponseerrordata.mdx) | ✅ | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.ServiceUnavailableResponseErrorData](../components/serviceunavailableresponseerrordata.mdx) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/toomanyrequestsresponseerror.mdx b/docs/errors/toomanyrequestsresponseerror.mdx index bd4d9b5df..67bd342ca 100644 --- a/docs/errors/toomanyrequestsresponseerror.mdx +++ b/docs/errors/toomanyrequestsresponseerror.mdx @@ -9,6 +9,6 @@ Too Many Requests - Rate limit exceeded | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.TooManyRequestsResponseErrorData](../components/toomanyrequestsresponseerrordata.mdx) | ✅ | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.TooManyRequestsResponseErrorData](../components/toomanyrequestsresponseerrordata.mdx) | :heavy_check_mark: | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/unauthorizedresponseerror.mdx b/docs/errors/unauthorizedresponseerror.mdx index 81fb945c0..a24d0576d 100644 --- a/docs/errors/unauthorizedresponseerror.mdx +++ b/docs/errors/unauthorizedresponseerror.mdx @@ -9,6 +9,6 @@ Unauthorized - Authentication required or invalid credentials | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `error` | [components.UnauthorizedResponseErrorData](../components/unauthorizedresponseerrordata.mdx) | ✅ | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.UnauthorizedResponseErrorData](../components/unauthorizedresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/errors/unprocessableentityresponseerror.mdx b/docs/errors/unprocessableentityresponseerror.mdx index 6e23a4c1d..75813e9f2 100644 --- a/docs/errors/unprocessableentityresponseerror.mdx +++ b/docs/errors/unprocessableentityresponseerror.mdx @@ -9,6 +9,6 @@ Unprocessable Entity - Semantic validation failure | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `error` | [components.UnprocessableEntityResponseErrorData](../components/unprocessableentityresponseerrordata.mdx) | ✅ | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | -| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | -| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file +| `error` | [components.UnprocessableEntityResponseErrorData](../components/unprocessableentityresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | +| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/internal/globals.mdx b/docs/models/internal/globals.mdx index 3ad2ee4c6..905f480d8 100644 --- a/docs/models/internal/globals.mdx +++ b/docs/models/internal/globals.mdx @@ -6,6 +6,6 @@ title: "Globals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/activateprivateendpointglobals.mdx b/docs/operations/activateprivateendpointglobals.mdx index fdc831c37..611b1a254 100644 --- a/docs/operations/activateprivateendpointglobals.mdx +++ b/docs/operations/activateprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "ActivatePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/activateprivateendpointrequest.mdx b/docs/operations/activateprivateendpointrequest.mdx index 1b7560155..fce127cf1 100644 --- a/docs/operations/activateprivateendpointrequest.mdx +++ b/docs/operations/activateprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "ActivatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/operations/bulkaddworkspacemembersglobals.mdx b/docs/operations/bulkaddworkspacemembersglobals.mdx index 29c0083fd..a53ed3696 100644 --- a/docs/operations/bulkaddworkspacemembersglobals.mdx +++ b/docs/operations/bulkaddworkspacemembersglobals.mdx @@ -6,6 +6,6 @@ title: "BulkAddWorkspaceMembersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkaddworkspacemembersrequest.mdx b/docs/operations/bulkaddworkspacemembersrequest.mdx index e0c7348a6..5b61022c5 100644 --- a/docs/operations/bulkaddworkspacemembersrequest.mdx +++ b/docs/operations/bulkaddworkspacemembersrequest.mdx @@ -6,8 +6,8 @@ title: "BulkAddWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `bulk_add_workspace_members_request` | [components.BulkAddWorkspaceMembersRequest](../components/bulkaddworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `bulk_add_workspace_members_request` | [components.BulkAddWorkspaceMembersRequest](../components/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/operations/bulkassignkeystoguardrailglobals.mdx b/docs/operations/bulkassignkeystoguardrailglobals.mdx index ec73b0f4e..c5e78a4b8 100644 --- a/docs/operations/bulkassignkeystoguardrailglobals.mdx +++ b/docs/operations/bulkassignkeystoguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "BulkAssignKeysToGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkassignkeystoguardrailrequest.mdx b/docs/operations/bulkassignkeystoguardrailrequest.mdx index d616eb4d6..47d8a382f 100644 --- a/docs/operations/bulkassignkeystoguardrailrequest.mdx +++ b/docs/operations/bulkassignkeystoguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "BulkAssignKeysToGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_assign_keys_request` | [components.BulkAssignKeysRequest](../components/bulkassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulk_assign_keys_request` | [components.BulkAssignKeysRequest](../components/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/operations/bulkassignmemberstoguardrailglobals.mdx b/docs/operations/bulkassignmemberstoguardrailglobals.mdx index ece4dcbc5..4b04ca8a6 100644 --- a/docs/operations/bulkassignmemberstoguardrailglobals.mdx +++ b/docs/operations/bulkassignmemberstoguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "BulkAssignMembersToGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkassignmemberstoguardrailrequest.mdx b/docs/operations/bulkassignmemberstoguardrailrequest.mdx index e51686259..ede199d37 100644 --- a/docs/operations/bulkassignmemberstoguardrailrequest.mdx +++ b/docs/operations/bulkassignmemberstoguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "BulkAssignMembersToGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_assign_members_request` | [components.BulkAssignMembersRequest](../components/bulkassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulk_assign_members_request` | [components.BulkAssignMembersRequest](../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/operations/bulkremoveworkspacemembersglobals.mdx b/docs/operations/bulkremoveworkspacemembersglobals.mdx index d88aa8b3d..9b483f8f2 100644 --- a/docs/operations/bulkremoveworkspacemembersglobals.mdx +++ b/docs/operations/bulkremoveworkspacemembersglobals.mdx @@ -6,6 +6,6 @@ title: "BulkRemoveWorkspaceMembersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkremoveworkspacemembersrequest.mdx b/docs/operations/bulkremoveworkspacemembersrequest.mdx index 9a3ec4bb7..40b348890 100644 --- a/docs/operations/bulkremoveworkspacemembersrequest.mdx +++ b/docs/operations/bulkremoveworkspacemembersrequest.mdx @@ -6,8 +6,8 @@ title: "BulkRemoveWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `bulk_remove_workspace_members_request` | [components.BulkRemoveWorkspaceMembersRequest](../components/bulkremoveworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `bulk_remove_workspace_members_request` | [components.BulkRemoveWorkspaceMembersRequest](../components/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/operations/bulkunassignkeysfromguardrailglobals.mdx b/docs/operations/bulkunassignkeysfromguardrailglobals.mdx index 2597202bd..0fee944ad 100644 --- a/docs/operations/bulkunassignkeysfromguardrailglobals.mdx +++ b/docs/operations/bulkunassignkeysfromguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "BulkUnassignKeysFromGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkunassignkeysfromguardrailrequest.mdx b/docs/operations/bulkunassignkeysfromguardrailrequest.mdx index 0e65d86de..fba4dbe77 100644 --- a/docs/operations/bulkunassignkeysfromguardrailrequest.mdx +++ b/docs/operations/bulkunassignkeysfromguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "BulkUnassignKeysFromGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_unassign_keys_request` | [components.BulkUnassignKeysRequest](../components/bulkunassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulk_unassign_keys_request` | [components.BulkUnassignKeysRequest](../components/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/operations/bulkunassignmembersfromguardrailglobals.mdx b/docs/operations/bulkunassignmembersfromguardrailglobals.mdx index 982423acc..e21cf59f2 100644 --- a/docs/operations/bulkunassignmembersfromguardrailglobals.mdx +++ b/docs/operations/bulkunassignmembersfromguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "BulkUnassignMembersFromGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkunassignmembersfromguardrailrequest.mdx b/docs/operations/bulkunassignmembersfromguardrailrequest.mdx index 0c20f96d7..de22a4c7b 100644 --- a/docs/operations/bulkunassignmembersfromguardrailrequest.mdx +++ b/docs/operations/bulkunassignmembersfromguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "BulkUnassignMembersFromGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_unassign_members_request` | [components.BulkUnassignMembersRequest](../components/bulkunassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulk_unassign_members_request` | [components.BulkUnassignMembersRequest](../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/operations/classifierdimensions.mdx b/docs/operations/classifierdimensions.mdx index ee620164f..f7cf34faf 100644 --- a/docs/operations/classifierdimensions.mdx +++ b/docs/operations/classifierdimensions.mdx @@ -9,6 +9,6 @@ Group results by custom classifier tags, breaking down metrics by the specified | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `classifier_id` | *str* | ✅ | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | -| `dimension_names` | List[*str*] | ➖ | N/A | | -| `include_nulls` | *Optional[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 +| `classifier_id` | *str* | :heavy_check_mark: | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | +| `dimension_names` | List[*str*] | :heavy_minus_sign: | N/A | | +| `include_nulls` | *Optional[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/operations/classifierfilters.mdx b/docs/operations/classifierfilters.mdx index 881b0849b..db4dbe946 100644 --- a/docs/operations/classifierfilters.mdx +++ b/docs/operations/classifierfilters.mdx @@ -9,5 +9,5 @@ Filter results to generations with specific classifier tag values. Can be combin | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `classifier_id` | *str* | ✅ | 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` | List[[operations.ClassifierFiltersFilter](../operations/classifierfiltersfilter.mdx)] | ✅ | N/A | | \ No newline at end of file +| `classifier_id` | *str* | :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` | List[[operations.ClassifierFiltersFilter](../operations/classifierfiltersfilter.mdx)] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/operations/classifierfiltersfilter.mdx b/docs/operations/classifierfiltersfilter.mdx index 01ce09fe2..f09e983a0 100644 --- a/docs/operations/classifierfiltersfilter.mdx +++ b/docs/operations/classifierfiltersfilter.mdx @@ -6,6 +6,6 @@ title: "ClassifierFiltersFilter" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field` | *str* | ✅ | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | -| `operator` | *str* | ✅ | 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](../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` | *str* | :heavy_check_mark: | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | +| `operator` | *str* | :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](../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/operations/contentimageurl.mdx b/docs/operations/contentimageurl.mdx index 7a5b2a7b9..d0e186ad1 100644 --- a/docs/operations/contentimageurl.mdx +++ b/docs/operations/contentimageurl.mdx @@ -6,5 +6,5 @@ title: "ContentImageURL" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `image_url` | [operations.ImageURL](../operations/imageurl.mdx) | ✅ | N/A | -| `type` | [operations.TypeImageURL](../operations/typeimageurl.mdx) | ✅ | N/A | \ No newline at end of file +| `image_url` | [operations.ImageURL](../operations/imageurl.mdx) | :heavy_check_mark: | N/A | +| `type` | [operations.TypeImageURL](../operations/typeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/contenttext.mdx b/docs/operations/contenttext.mdx index 286bcb97e..08e418f7b 100644 --- a/docs/operations/contenttext.mdx +++ b/docs/operations/contenttext.mdx @@ -6,5 +6,5 @@ title: "ContentText" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `text` | *str* | ✅ | N/A | -| `type` | [operations.TypeText](../operations/typetext.mdx) | ✅ | N/A | \ No newline at end of file +| `text` | *str* | :heavy_check_mark: | N/A | +| `type` | [operations.TypeText](../operations/typetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/copyvaultsecretstointernglobals.mdx b/docs/operations/copyvaultsecretstointernglobals.mdx index 6d6b8b426..56423f3ad 100644 --- a/docs/operations/copyvaultsecretstointernglobals.mdx +++ b/docs/operations/copyvaultsecretstointernglobals.mdx @@ -6,6 +6,6 @@ title: "CopyVaultSecretsToInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/copyvaultsecretstointernrequest.mdx b/docs/operations/copyvaultsecretstointernrequest.mdx index 892f9eb51..17c655cf0 100644 --- a/docs/operations/copyvaultsecretstointernrequest.mdx +++ b/docs/operations/copyvaultsecretstointernrequest.mdx @@ -6,8 +6,8 @@ title: "CopyVaultSecretsToInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `vault_secret_copy_request` | [components.VaultSecretCopyRequest](../components/vaultsecretcopyrequest.mdx) | ✅ | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `vault_secret_copy_request` | [components.VaultSecretCopyRequest](../components/vaultsecretcopyrequest.mdx) | :heavy_check_mark: | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file diff --git a/docs/operations/createapialphadecisionsglobals.mdx b/docs/operations/createapialphadecisionsglobals.mdx index 35ed6138c..2fc93732f 100644 --- a/docs/operations/createapialphadecisionsglobals.mdx +++ b/docs/operations/createapialphadecisionsglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAPIAlphaDecisionsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createapialphadecisionsrequest.mdx b/docs/operations/createapialphadecisionsrequest.mdx index 153a9786f..efdf720f6 100644 --- a/docs/operations/createapialphadecisionsrequest.mdx +++ b/docs/operations/createapialphadecisionsrequest.mdx @@ -6,7 +6,7 @@ title: "CreateAPIAlphaDecisionsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `decisions_request` | [components.DecisionsRequest](../components/decisionsrequest.mdx) | ✅ | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `decisions_request` | [components.DecisionsRequest](../components/decisionsrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/createaudiospeechglobals.mdx b/docs/operations/createaudiospeechglobals.mdx index a2404fcab..78fe3a35c 100644 --- a/docs/operations/createaudiospeechglobals.mdx +++ b/docs/operations/createaudiospeechglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAudioSpeechGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createaudiospeechrequest.mdx b/docs/operations/createaudiospeechrequest.mdx index 2b933a1f8..a9aaac38a 100644 --- a/docs/operations/createaudiospeechrequest.mdx +++ b/docs/operations/createaudiospeechrequest.mdx @@ -6,7 +6,7 @@ title: "CreateAudioSpeechRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `speech_request` | [components.SpeechRequest](../components/speechrequest.mdx) | ✅ | N/A | \{
"input": "Hello world",
"model": "mistralai/voxtral-mini-tts-2603",
"response_format": "pcm",
"speed": 1,
"voice": "en_paul_neutral"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `speech_request` | [components.SpeechRequest](../components/speechrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": "Hello world",
"model": "mistralai/voxtral-mini-tts-2603",
"response_format": "pcm",
"speed": 1,
"voice": "en_paul_neutral"
} | \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsglobals.mdx b/docs/operations/createaudiotranscriptionsglobals.mdx index 5b1e0b2bb..2427dcaa5 100644 --- a/docs/operations/createaudiotranscriptionsglobals.mdx +++ b/docs/operations/createaudiotranscriptionsglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAudioTranscriptionsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsmultipartfile.mdx b/docs/operations/createaudiotranscriptionsmultipartfile.mdx index aed4e7f79..3fa3d99a9 100644 --- a/docs/operations/createaudiotranscriptionsmultipartfile.mdx +++ b/docs/operations/createaudiotranscriptionsmultipartfile.mdx @@ -6,6 +6,6 @@ title: "CreateAudioTranscriptionsMultipartFile" | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `file_name` | *str* | ✅ | N/A | -| `content` | *Union[bytes, IO[bytes], io.IOBase]* | ✅ | N/A | -| `content_type` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `file_name` | *str* | :heavy_check_mark: | N/A | +| `content` | *Union[bytes, IO[bytes], io.IOBase]* | :heavy_check_mark: | N/A | +| `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsmultipartglobals.mdx b/docs/operations/createaudiotranscriptionsmultipartglobals.mdx index 701bc6259..40d3f1222 100644 --- a/docs/operations/createaudiotranscriptionsmultipartglobals.mdx +++ b/docs/operations/createaudiotranscriptionsmultipartglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAudioTranscriptionsMultipartGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsmultipartrequest.mdx b/docs/operations/createaudiotranscriptionsmultipartrequest.mdx index 06e96faa3..b5031668e 100644 --- a/docs/operations/createaudiotranscriptionsmultipartrequest.mdx +++ b/docs/operations/createaudiotranscriptionsmultipartrequest.mdx @@ -6,7 +6,7 @@ title: "CreateAudioTranscriptionsMultipartRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `request_body` | [operations.CreateAudioTranscriptionsMultipartRequestBody](../operations/createaudiotranscriptionsmultipartrequestbody.mdx) | ✅ | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `request_body` | [operations.CreateAudioTranscriptionsMultipartRequestBody](../operations/createaudiotranscriptionsmultipartrequestbody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsmultipartrequestbody.mdx b/docs/operations/createaudiotranscriptionsmultipartrequestbody.mdx index 08284aaa6..784fc7b0f 100644 --- a/docs/operations/createaudiotranscriptionsmultipartrequestbody.mdx +++ b/docs/operations/createaudiotranscriptionsmultipartrequestbody.mdx @@ -6,16 +6,16 @@ title: "CreateAudioTranscriptionsMultipartRequestBody" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `diarize` | *Optional[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` | [Optional[operations.CreateAudioTranscriptionsMultipartFile]](../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` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | The language of the input audio (ISO-639-1). | -| `model` | *str* | ✅ | The model to use for transcription. | -| `provider` | *Optional[str]* | ➖ | 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. | -| `response_format` | [Optional[operations.ResponseFormat]](../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). | -| `session_id` | *Optional[str]* | ➖ | 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. | -| `source_url` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | The sampling temperature. | -| `timestamp_granularities` | List[[operations.TimestampGranularities](../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | *Optional[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` | [Optional[operations.CreateAudioTranscriptionsMultipartFile]](../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` | List[*str*] | :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` | *Optional[str]* | :heavy_minus_sign: | The language of the input audio (ISO-639-1). | +| `model` | *str* | :heavy_check_mark: | The model to use for transcription. | +| `provider` | *Optional[str]* | :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. | +| `response_format` | [Optional[operations.ResponseFormat]](../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). | +| `session_id` | *Optional[str]* | :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. | +| `source_url` | *Optional[str]* | :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` | *Optional[float]* | :heavy_minus_sign: | The sampling temperature. | +| `timestamp_granularities` | List[[operations.TimestampGranularities](../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` | *Optional[str]* | :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` | *Optional[str]* | :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/operations/createaudiotranscriptionsrequest.mdx b/docs/operations/createaudiotranscriptionsrequest.mdx index 4774c6ed6..63faa868b 100644 --- a/docs/operations/createaudiotranscriptionsrequest.mdx +++ b/docs/operations/createaudiotranscriptionsrequest.mdx @@ -6,7 +6,7 @@ title: "CreateAudioTranscriptionsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `stt_request` | [components.STTRequest](../components/sttrequest.mdx) | ✅ | N/A | \{
"input_audio": \{
"data": "UklGRiQA...",
"format": "wav"
},
"language": "en",
"model": "openai/whisper-large-v3"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `stt_request` | [components.STTRequest](../components/sttrequest.mdx) | :heavy_check_mark: | N/A | \{
"input_audio": \{
"data": "UklGRiQA...",
"format": "wav"
},
"language": "en",
"model": "openai/whisper-large-v3"
} | \ No newline at end of file diff --git a/docs/operations/createauthkeyscodedata.mdx b/docs/operations/createauthkeyscodedata.mdx index 01c6f5f53..7089ba199 100644 --- a/docs/operations/createauthkeyscodedata.mdx +++ b/docs/operations/createauthkeyscodedata.mdx @@ -9,6 +9,6 @@ Auth code data | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `app_id` | *int* | ✅ | The application ID associated with this auth code | 12345 | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | -| `id` | *str* | ✅ | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file +| `app_id` | *int* | :heavy_check_mark: | The application ID associated with this auth code | 12345 | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | +| `id` | *str* | :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/operations/createauthkeyscodeglobals.mdx b/docs/operations/createauthkeyscodeglobals.mdx index adbbf2d91..4332a2403 100644 --- a/docs/operations/createauthkeyscodeglobals.mdx +++ b/docs/operations/createauthkeyscodeglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAuthKeysCodeGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createauthkeyscoderequest.mdx b/docs/operations/createauthkeyscoderequest.mdx index e3aa5efe2..cdafce622 100644 --- a/docs/operations/createauthkeyscoderequest.mdx +++ b/docs/operations/createauthkeyscoderequest.mdx @@ -6,7 +6,7 @@ title: "CreateAuthKeysCodeRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateAuthKeysCodeRequestBody](../operations/createauthkeyscoderequestbody.mdx) | ✅ | N/A | \{
"callback_url": "https://myapp.com/auth/callback",
"code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM",
"code_challenge_method": "S256",
"limit": 100
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.CreateAuthKeysCodeRequestBody](../operations/createauthkeyscoderequestbody.mdx) | :heavy_check_mark: | N/A | \{
"callback_url": "https://myapp.com/auth/callback",
"code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM",
"code_challenge_method": "S256",
"limit": 100
} | \ No newline at end of file diff --git a/docs/operations/createauthkeyscoderequestbody.mdx b/docs/operations/createauthkeyscoderequestbody.mdx index a083a0ba0..8d91bb3f3 100644 --- a/docs/operations/createauthkeyscoderequestbody.mdx +++ b/docs/operations/createauthkeyscoderequestbody.mdx @@ -6,11 +6,11 @@ title: "CreateAuthKeysCodeRequestBody" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `callback_url` | *str* | ✅ | 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 | -| `code_challenge` | *Optional[str]* | ➖ | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../operations/createauthkeyscodecodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | 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 | -| `key_label` | *Optional[str]* | ➖ | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | -| `limit` | *Optional[float]* | ➖ | Credit limit for the API key to be created | 100 | -| `usage_limit_type` | [Optional[operations.UsageLimitType]](../operations/usagelimittype.mdx) | ➖ | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | -| `workspace_id` | *Optional[str]* | ➖ | Optional workspace ID to associate the API key with | | \ No newline at end of file +| `callback_url` | *str* | :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 | +| `code_challenge` | *Optional[str]* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | +| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../operations/createauthkeyscodecodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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 | +| `key_label` | *Optional[str]* | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | +| `limit` | *Optional[float]* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | +| `usage_limit_type` | [Optional[operations.UsageLimitType]](../operations/usagelimittype.mdx) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to associate the API key with | | \ No newline at end of file diff --git a/docs/operations/createauthkeyscoderesponse.mdx b/docs/operations/createauthkeyscoderesponse.mdx index acff25e74..5044f5777 100644 --- a/docs/operations/createauthkeyscoderesponse.mdx +++ b/docs/operations/createauthkeyscoderesponse.mdx @@ -9,4 +9,4 @@ Successfully created authorization code | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `data` | [operations.CreateAuthKeysCodeData](../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](../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/operations/createbatchesglobals.mdx b/docs/operations/createbatchesglobals.mdx index 79969fac2..3fc8554f3 100644 --- a/docs/operations/createbatchesglobals.mdx +++ b/docs/operations/createbatchesglobals.mdx @@ -6,6 +6,6 @@ title: "CreateBatchesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createbatchesrequest.mdx b/docs/operations/createbatchesrequest.mdx index ebf930c1a..a809455bb 100644 --- a/docs/operations/createbatchesrequest.mdx +++ b/docs/operations/createbatchesrequest.mdx @@ -6,7 +6,7 @@ title: "CreateBatchesRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `batch_submit_body` | [components.BatchSubmitBody](../components/batchsubmitbody.mdx) | ✅ | The batch to create. Each item in `requests` has a unique `custom_id` and a `body` in the request format of the chosen `endpoint`. | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `batch_submit_body` | [components.BatchSubmitBody](../components/batchsubmitbody.mdx) | :heavy_check_mark: | The batch to create. Each item in `requests` has a unique `custom_id` and a `body` in the request format of the chosen `endpoint`. | \ No newline at end of file diff --git a/docs/operations/createbyokkeyglobals.mdx b/docs/operations/createbyokkeyglobals.mdx index 775f6caeb..7a4e3e75e 100644 --- a/docs/operations/createbyokkeyglobals.mdx +++ b/docs/operations/createbyokkeyglobals.mdx @@ -6,6 +6,6 @@ title: "CreateBYOKKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createbyokkeyrequest.mdx b/docs/operations/createbyokkeyrequest.mdx index 172b19af4..f8b09da30 100644 --- a/docs/operations/createbyokkeyrequest.mdx +++ b/docs/operations/createbyokkeyrequest.mdx @@ -6,7 +6,7 @@ title: "CreateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_byok_key_request` | [components.CreateBYOKKeyRequest](../components/createbyokkeyrequest.mdx) | ✅ | N/A | \{
"key": "sk-proj-abc123...",
"name": "Production OpenAI Key",
"provider": "openai"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_byok_key_request` | [components.CreateBYOKKeyRequest](../components/createbyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"key": "sk-proj-abc123...",
"name": "Production OpenAI Key",
"provider": "openai"
} | \ No newline at end of file diff --git a/docs/operations/createembeddingsdata.mdx b/docs/operations/createembeddingsdata.mdx index 2bc84c96b..07670e00c 100644 --- a/docs/operations/createembeddingsdata.mdx +++ b/docs/operations/createembeddingsdata.mdx @@ -9,6 +9,6 @@ A single embedding object | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `embedding` | [operations.Embedding](../operations/embedding.mdx) | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `index` | *Optional[int]* | ➖ | Index of the embedding in the input list | 0 | -| `object` | [operations.ObjectEmbedding](../operations/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file +| `embedding` | [operations.Embedding](../operations/embedding.mdx) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the embedding in the input list | 0 | +| `object` | [operations.ObjectEmbedding](../operations/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/operations/createembeddingsglobals.mdx b/docs/operations/createembeddingsglobals.mdx index 1e7bd5590..2325d62eb 100644 --- a/docs/operations/createembeddingsglobals.mdx +++ b/docs/operations/createembeddingsglobals.mdx @@ -6,6 +6,6 @@ title: "CreateEmbeddingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createembeddingsrequest.mdx b/docs/operations/createembeddingsrequest.mdx index 22f6a5c0a..6d20f0154 100644 --- a/docs/operations/createembeddingsrequest.mdx +++ b/docs/operations/createembeddingsrequest.mdx @@ -6,7 +6,7 @@ title: "CreateEmbeddingsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateEmbeddingsRequestBody](../operations/createembeddingsrequestbody.mdx) | ✅ | N/A | \{
"dimensions": 1536,
"input": "The quick brown fox jumps over the lazy dog",
"model": "openai/text-embedding-3-small"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.CreateEmbeddingsRequestBody](../operations/createembeddingsrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"dimensions": 1536,
"input": "The quick brown fox jumps over the lazy dog",
"model": "openai/text-embedding-3-small"
} | \ No newline at end of file diff --git a/docs/operations/createembeddingsrequestbody.mdx b/docs/operations/createembeddingsrequestbody.mdx index 30ca7a79f..80bb5d5af 100644 --- a/docs/operations/createembeddingsrequestbody.mdx +++ b/docs/operations/createembeddingsrequestbody.mdx @@ -9,12 +9,12 @@ Embeddings request input | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dimensions` | *Optional[int]* | ➖ | The number of dimensions for the output embeddings | 1536 | -| `encoding_format` | [Optional[operations.EncodingFormat]](../operations/encodingformat.mdx) | ➖ | The format of the output embeddings | float | -| `input` | [operations.InputUnion](../operations/inputunion.mdx) | ✅ | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `input_type` | *Optional[str]* | ➖ | The type of input (e.g. search_query, search_document) | search_query | -| `model` | *str* | ✅ | The model to use for embeddings | openai/text-embedding-3-small | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | ➖ | 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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | A unique identifier for the end-user | user-1234 | \ No newline at end of file +| `dimensions` | *Optional[int]* | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | +| `encoding_format` | [Optional[operations.EncodingFormat]](../operations/encodingformat.mdx) | :heavy_minus_sign: | The format of the output embeddings | float | +| `input` | [operations.InputUnion](../operations/inputunion.mdx) | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | +| `input_type` | *Optional[str]* | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | +| `model` | *str* | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | :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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | \ No newline at end of file diff --git a/docs/operations/createembeddingsresponsebody.mdx b/docs/operations/createembeddingsresponsebody.mdx index e16f95a89..4efeda7aa 100644 --- a/docs/operations/createembeddingsresponsebody.mdx +++ b/docs/operations/createembeddingsresponsebody.mdx @@ -9,8 +9,8 @@ Embeddings response containing embedding vectors | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | List[[operations.CreateEmbeddingsData](../operations/createembeddingsdata.mdx)] | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `id` | *Optional[str]* | ➖ | Unique identifier for the embeddings response | embd-1234567890 | -| `model` | *str* | ✅ | The model used for embeddings | openai/text-embedding-3-small | -| `object` | [operations.Object](../operations/object.mdx) | ✅ | N/A | | -| `usage` | [Optional[operations.CreateEmbeddingsUsage]](../operations/createembeddingsusage.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `data` | List[[operations.CreateEmbeddingsData](../operations/createembeddingsdata.mdx)] | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | +| `model` | *str* | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | +| `object` | [operations.Object](../operations/object.mdx) | :heavy_check_mark: | N/A | | +| `usage` | [Optional[operations.CreateEmbeddingsUsage]](../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/operations/createembeddingsusage.mdx b/docs/operations/createembeddingsusage.mdx index 073e9202f..1218cf960 100644 --- a/docs/operations/createembeddingsusage.mdx +++ b/docs/operations/createembeddingsusage.mdx @@ -9,9 +9,9 @@ Token usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cost` | *Optional[float]* | ➖ | Cost of the request in credits | 0.0001 | -| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `prompt_tokens` | *int* | ✅ | Number of tokens in the input | 8 | -| `prompt_tokens_details` | [Optional[operations.PromptTokensDetails]](../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. | | -| `total_tokens` | *int* | ✅ | Total number of tokens used | 8 | \ No newline at end of file +| `cost` | *Optional[float]* | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | +| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | +| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `prompt_tokens` | *int* | :heavy_check_mark: | Number of tokens in the input | 8 | +| `prompt_tokens_details` | [Optional[operations.PromptTokensDetails]](../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. | | +| `total_tokens` | *int* | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/operations/createenduserglobals.mdx b/docs/operations/createenduserglobals.mdx index e889ab3a4..e420bbbee 100644 --- a/docs/operations/createenduserglobals.mdx +++ b/docs/operations/createenduserglobals.mdx @@ -6,6 +6,6 @@ title: "CreateEndUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createenduserrequest.mdx b/docs/operations/createenduserrequest.mdx index 90a760679..9448f5084 100644 --- a/docs/operations/createenduserrequest.mdx +++ b/docs/operations/createenduserrequest.mdx @@ -6,7 +6,7 @@ title: "CreateEndUserRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_end_user_request` | [components.CreateEndUserRequest](../components/createenduserrequest.mdx) | ✅ | N/A | \{
"user": "employee_123"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_end_user_request` | [components.CreateEndUserRequest](../components/createenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"user": "employee_123"
} | \ No newline at end of file diff --git a/docs/operations/createguardrailglobals.mdx b/docs/operations/createguardrailglobals.mdx index 9e71c1bd5..89d6df049 100644 --- a/docs/operations/createguardrailglobals.mdx +++ b/docs/operations/createguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "CreateGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createguardrailrequest.mdx b/docs/operations/createguardrailrequest.mdx index 806a16bf9..645bf9a23 100644 --- a/docs/operations/createguardrailrequest.mdx +++ b/docs/operations/createguardrailrequest.mdx @@ -6,7 +6,7 @@ title: "CreateGuardrailRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_guardrail_request` | [components.CreateGuardrailRequest](../components/createguardrailrequest.mdx) | ✅ | N/A | \{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"deepseek"
],
"content_filter_builtins": [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
],
"content_filters": null,
"description": "A guardrail for limiting API usage",
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"ignored_models": null,
"ignored_providers": null,
"limit_usd": 50,
"name": "My New Guardrail",
"reset_interval": "monthly"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_guardrail_request` | [components.CreateGuardrailRequest](../components/createguardrailrequest.mdx) | :heavy_check_mark: | N/A | \{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"deepseek"
],
"content_filter_builtins": [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
],
"content_filters": null,
"description": "A guardrail for limiting API usage",
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"ignored_models": null,
"ignored_providers": null,
"limit_usd": 50,
"name": "My New Guardrail",
"reset_interval": "monthly"
} | \ No newline at end of file diff --git a/docs/operations/createimagesglobals.mdx b/docs/operations/createimagesglobals.mdx index a6c441986..98b5f6f8e 100644 --- a/docs/operations/createimagesglobals.mdx +++ b/docs/operations/createimagesglobals.mdx @@ -6,6 +6,6 @@ title: "CreateImagesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createimagesrequest.mdx b/docs/operations/createimagesrequest.mdx index 25813721c..5e9a2d730 100644 --- a/docs/operations/createimagesrequest.mdx +++ b/docs/operations/createimagesrequest.mdx @@ -6,7 +6,7 @@ title: "CreateImagesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `image_generation_request` | [components.ImageGenerationRequest](../components/imagegenerationrequest.mdx) | ✅ | N/A | \{
"model": "bytedance-seed/seedream-4.5",
"prompt": "a red panda astronaut floating in space, studio lighting"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `image_generation_request` | [components.ImageGenerationRequest](../components/imagegenerationrequest.mdx) | :heavy_check_mark: | N/A | \{
"model": "bytedance-seed/seedream-4.5",
"prompt": "a red panda astronaut floating in space, studio lighting"
} | \ No newline at end of file diff --git a/docs/operations/createinternchatcompletionglobals.mdx b/docs/operations/createinternchatcompletionglobals.mdx index 1c8248404..561b72c40 100644 --- a/docs/operations/createinternchatcompletionglobals.mdx +++ b/docs/operations/createinternchatcompletionglobals.mdx @@ -6,6 +6,6 @@ title: "CreateInternChatCompletionGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createinternchatcompletionrequest.mdx b/docs/operations/createinternchatcompletionrequest.mdx index bad5ae9c4..a4bd48afd 100644 --- a/docs/operations/createinternchatcompletionrequest.mdx +++ b/docs/operations/createinternchatcompletionrequest.mdx @@ -6,8 +6,8 @@ title: "CreateInternChatCompletionRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | -| `intern_chat_completion_request` | [components.InternChatCompletionRequest](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | +| `intern_chat_completion_request` | [components.InternChatCompletionRequest](../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/operations/createinternchatcompletionresponse.mdx b/docs/operations/createinternchatcompletionresponse.mdx index 591187f24..6c0f59590 100644 --- a/docs/operations/createinternchatcompletionresponse.mdx +++ b/docs/operations/createinternchatcompletionresponse.mdx @@ -6,5 +6,5 @@ title: "CreateInternChatCompletionResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | ✅ | N/A | -| `result` | [operations.CreateInternChatCompletionResponseResult](../operations/createinternchatcompletionresponseresult.mdx) | ✅ | N/A | \ No newline at end of file +| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | +| `result` | [operations.CreateInternChatCompletionResponseResult](../operations/createinternchatcompletionresponseresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/createinternglobals.mdx b/docs/operations/createinternglobals.mdx index f9f614160..8eb5e1fc3 100644 --- a/docs/operations/createinternglobals.mdx +++ b/docs/operations/createinternglobals.mdx @@ -6,6 +6,6 @@ title: "CreateInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createinternrequest.mdx b/docs/operations/createinternrequest.mdx index 131f791d7..b3a223489 100644 --- a/docs/operations/createinternrequest.mdx +++ b/docs/operations/createinternrequest.mdx @@ -6,8 +6,8 @@ title: "CreateInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotency_key` | *Optional[str]* | ➖ | 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 | -| `create_intern_request` | [components.CreateInternRequest](../components/createinternrequest.mdx) | ✅ | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotency_key` | *Optional[str]* | :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 | +| `create_intern_request` | [components.CreateInternRequest](../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/operations/createkeysdata.mdx b/docs/operations/createkeysdata.mdx index 0b1392e1f..18bb520f7 100644 --- a/docs/operations/createkeysdata.mdx +++ b/docs/operations/createkeysdata.mdx @@ -9,26 +9,26 @@ The created API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | ✅ | 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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `external_user` | *Nullable[str]* | ✅ | Partner's end-user identifier used for attribution. | null | -| `hash` | *str* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | -| `name` | *str* | ✅ | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creator_user_id` | *Nullable[str]* | :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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `external_user` | *Nullable[str]* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | +| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | +| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *str* | :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/operations/createkeysglobals.mdx b/docs/operations/createkeysglobals.mdx index 1fc891b1e..976d57a66 100644 --- a/docs/operations/createkeysglobals.mdx +++ b/docs/operations/createkeysglobals.mdx @@ -6,6 +6,6 @@ title: "CreateKeysGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createkeysrequest.mdx b/docs/operations/createkeysrequest.mdx index 4eaf6be4e..9ec01bf61 100644 --- a/docs/operations/createkeysrequest.mdx +++ b/docs/operations/createkeysrequest.mdx @@ -6,7 +6,7 @@ title: "CreateKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateKeysRequestBody](../operations/createkeysrequestbody.mdx) | ✅ | N/A | \{
"expires_at": "2027-12-31T23:59:59Z",
"include_byok_in_limit": true,
"limit": 50,
"limit_reset": "monthly",
"name": "My New API Key"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.CreateKeysRequestBody](../operations/createkeysrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"expires_at": "2027-12-31T23:59:59Z",
"include_byok_in_limit": true,
"limit": 50,
"limit_reset": "monthly",
"name": "My New API Key"
} | \ No newline at end of file diff --git a/docs/operations/createkeysrequestbody.mdx b/docs/operations/createkeysrequestbody.mdx index d9d0ab78f..b07f92407 100644 --- a/docs/operations/createkeysrequestbody.mdx +++ b/docs/operations/createkeysrequestbody.mdx @@ -6,11 +6,11 @@ title: "CreateKeysRequestBody" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `creator_user_id` | *OptionalNullable[str]* | ➖ | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | 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` | [Optional[operations.External]](../operations/external.mdx) | ➖ | Optional partner-defined identity associated with the created API key. | | -| `include_byok_in_limit` | *Optional[bool]* | ➖ | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | ➖ | Optional spending limit for the API key in USD | 50 | -| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../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` | *str* | ✅ | Name for the new API key | My New API Key | -| `workspace_id` | *Optional[str]* | ➖ | 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 +| `creator_user_id` | *OptionalNullable[str]* | :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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | [Optional[operations.External]](../operations/external.mdx) | :heavy_minus_sign: | Optional partner-defined identity associated with the created API key. | | +| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | +| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | +| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../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` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key | +| `workspace_id` | *Optional[str]* | :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/operations/createkeysresponse.mdx b/docs/operations/createkeysresponse.mdx index f000615cd..ef2250aec 100644 --- a/docs/operations/createkeysresponse.mdx +++ b/docs/operations/createkeysresponse.mdx @@ -9,5 +9,5 @@ API key created successfully | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateKeysData](../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` | *str* | ✅ | The actual API key string (only shown once) | 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 | \ No newline at end of file +| `data` | [operations.CreateKeysData](../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` | *str* | :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/operations/createoauthtokenglobals.mdx b/docs/operations/createoauthtokenglobals.mdx index 4e670bfed..5bf9b60d1 100644 --- a/docs/operations/createoauthtokenglobals.mdx +++ b/docs/operations/createoauthtokenglobals.mdx @@ -6,6 +6,6 @@ title: "CreateOauthTokenGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createoauthtokenrequest.mdx b/docs/operations/createoauthtokenrequest.mdx index 82d5dceb6..ce9fcd9ae 100644 --- a/docs/operations/createoauthtokenrequest.mdx +++ b/docs/operations/createoauthtokenrequest.mdx @@ -6,7 +6,7 @@ title: "CreateOauthTokenRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `token_exchange_request` | [components.TokenExchangeRequest](../components/tokenexchangerequest.mdx) | ✅ | N/A | \{
"federation_policy_id": "4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b",
"grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
"subject_token": "\u003cjwt from your identity provider\u003e",
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `token_exchange_request` | [components.TokenExchangeRequest](../components/tokenexchangerequest.mdx) | :heavy_check_mark: | N/A | \{
"federation_policy_id": "4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b",
"grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
"subject_token": "\u003cjwt from your identity provider\u003e",
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt"
} | \ No newline at end of file diff --git a/docs/operations/createobservabilitydestinationglobals.mdx b/docs/operations/createobservabilitydestinationglobals.mdx index a9917e497..778aba142 100644 --- a/docs/operations/createobservabilitydestinationglobals.mdx +++ b/docs/operations/createobservabilitydestinationglobals.mdx @@ -6,6 +6,6 @@ title: "CreateObservabilityDestinationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createobservabilitydestinationrequest.mdx b/docs/operations/createobservabilitydestinationrequest.mdx index 98af6502c..3c62d6ca4 100644 --- a/docs/operations/createobservabilitydestinationrequest.mdx +++ b/docs/operations/createobservabilitydestinationrequest.mdx @@ -6,7 +6,7 @@ title: "CreateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_observability_destination_request` | [components.CreateObservabilityDestinationRequest](../components/createobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"name": "Production Langfuse",
"type": "langfuse"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_observability_destination_request` | [components.CreateObservabilityDestinationRequest](../components/createobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"name": "Production Langfuse",
"type": "langfuse"
} | \ No newline at end of file diff --git a/docs/operations/createpresetschatcompletionsglobals.mdx b/docs/operations/createpresetschatcompletionsglobals.mdx index f6af0e4e2..47f311158 100644 --- a/docs/operations/createpresetschatcompletionsglobals.mdx +++ b/docs/operations/createpresetschatcompletionsglobals.mdx @@ -6,6 +6,6 @@ title: "CreatePresetsChatCompletionsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createpresetschatcompletionsrequest.mdx b/docs/operations/createpresetschatcompletionsrequest.mdx index 905ae6446..c6bd78077 100644 --- a/docs/operations/createpresetschatcompletionsrequest.mdx +++ b/docs/operations/createpresetschatcompletionsrequest.mdx @@ -6,8 +6,8 @@ title: "CreatePresetsChatCompletionsRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `chat_request` | [components.ChatRequest](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `chat_request` | [components.ChatRequest](../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/operations/createpresetsmessagesglobals.mdx b/docs/operations/createpresetsmessagesglobals.mdx index 49374471b..278c5d1f8 100644 --- a/docs/operations/createpresetsmessagesglobals.mdx +++ b/docs/operations/createpresetsmessagesglobals.mdx @@ -6,6 +6,6 @@ title: "CreatePresetsMessagesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createpresetsmessagesrequest.mdx b/docs/operations/createpresetsmessagesrequest.mdx index 62fe58670..71d6249ed 100644 --- a/docs/operations/createpresetsmessagesrequest.mdx +++ b/docs/operations/createpresetsmessagesrequest.mdx @@ -6,8 +6,8 @@ title: "CreatePresetsMessagesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messages_request` | [components.MessagesRequest](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `messages_request` | [components.MessagesRequest](../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/operations/createpresetsresponsesglobals.mdx b/docs/operations/createpresetsresponsesglobals.mdx index f410ec4d4..9d4fce86d 100644 --- a/docs/operations/createpresetsresponsesglobals.mdx +++ b/docs/operations/createpresetsresponsesglobals.mdx @@ -6,6 +6,6 @@ title: "CreatePresetsResponsesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createpresetsresponsesrequest.mdx b/docs/operations/createpresetsresponsesrequest.mdx index e7b6d9c42..54dde0eb3 100644 --- a/docs/operations/createpresetsresponsesrequest.mdx +++ b/docs/operations/createpresetsresponsesrequest.mdx @@ -6,8 +6,8 @@ title: "CreatePresetsResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `responses_request` | [components.ResponsesRequest](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `responses_request` | [components.ResponsesRequest](../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/operations/createprivateendpointglobals.mdx b/docs/operations/createprivateendpointglobals.mdx index f59c981db..700ae51c2 100644 --- a/docs/operations/createprivateendpointglobals.mdx +++ b/docs/operations/createprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "CreatePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createprivateendpointrequest.mdx b/docs/operations/createprivateendpointrequest.mdx index 8039e542b..175cee0cd 100644 --- a/docs/operations/createprivateendpointrequest.mdx +++ b/docs/operations/createprivateendpointrequest.mdx @@ -6,8 +6,8 @@ title: "CreatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotency_key` | *Optional[str]* | ➖ | 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 | -| `create_private_endpoint_request` | [components.CreatePrivateEndpointRequest](../components/createprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotency_key` | *Optional[str]* | :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 | +| `create_private_endpoint_request` | [components.CreatePrivateEndpointRequest](../components/createprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/operations/creatererankglobals.mdx b/docs/operations/creatererankglobals.mdx index 01d7cf585..e0e136ff2 100644 --- a/docs/operations/creatererankglobals.mdx +++ b/docs/operations/creatererankglobals.mdx @@ -6,6 +6,6 @@ title: "CreateRerankGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/creatererankrequest.mdx b/docs/operations/creatererankrequest.mdx index 992b7e157..f0d351fc5 100644 --- a/docs/operations/creatererankrequest.mdx +++ b/docs/operations/creatererankrequest.mdx @@ -6,7 +6,7 @@ title: "CreateRerankRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateRerankRequestBody](../operations/creatererankrequestbody.mdx) | ✅ | N/A | \{
"documents": [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
],
"model": "cohere/rerank-v3.5",
"query": "What is the capital of France?",
"top_n": 3
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.CreateRerankRequestBody](../operations/creatererankrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"documents": [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
],
"model": "cohere/rerank-v3.5",
"query": "What is the capital of France?",
"top_n": 3
} | \ No newline at end of file diff --git a/docs/operations/creatererankrequestbody.mdx b/docs/operations/creatererankrequestbody.mdx index 476f2bd73..f1021ad1c 100644 --- a/docs/operations/creatererankrequestbody.mdx +++ b/docs/operations/creatererankrequestbody.mdx @@ -9,11 +9,11 @@ Rerank request input | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `documents` | List[[operations.Document](../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` | *str* | ✅ | The rerank model to use | cohere/rerank-v3.5 | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `query` | *str* | ✅ | The search query to rerank documents against | What is the capital of France? | -| `session_id` | *Optional[str]* | ➖ | 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 | -| `top_n` | *Optional[int]* | ➖ | Number of most relevant documents to return | 3 | -| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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` | List[[operations.Document](../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` | *str* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `query` | *str* | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | +| `session_id` | *Optional[str]* | :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 | +| `top_n` | *Optional[int]* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | +| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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/operations/creatererankresponsebody.mdx b/docs/operations/creatererankresponsebody.mdx index 3df8a615e..9dc87532b 100644 --- a/docs/operations/creatererankresponsebody.mdx +++ b/docs/operations/creatererankresponsebody.mdx @@ -9,8 +9,8 @@ Rerank response containing ranked results | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `id` | *Optional[str]* | ➖ | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | -| `model` | *str* | ✅ | The model used for reranking | cohere/rerank-v3.5 | -| `provider` | *Optional[str]* | ➖ | The provider that served the rerank request | Cohere | -| `results` | List[[operations.Result](../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` | [Optional[operations.CreateRerankUsage]](../operations/creatererankusage.mdx) | ➖ | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | +| `model` | *str* | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 | +| `provider` | *Optional[str]* | :heavy_minus_sign: | The provider that served the rerank request | Cohere | +| `results` | List[[operations.Result](../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` | [Optional[operations.CreateRerankUsage]](../operations/creatererankusage.mdx) | :heavy_minus_sign: | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file diff --git a/docs/operations/creatererankusage.mdx b/docs/operations/creatererankusage.mdx index a10d64e26..66beef7ea 100644 --- a/docs/operations/creatererankusage.mdx +++ b/docs/operations/creatererankusage.mdx @@ -9,6 +9,6 @@ Usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `cost` | *Optional[float]* | ➖ | Cost of the request in credits | 0.001 | -| `search_units` | *Optional[int]* | ➖ | Number of search units consumed (Cohere billing) | 1 | -| `total_tokens` | *Optional[int]* | ➖ | Total number of tokens used | 150 | \ No newline at end of file +| `cost` | *Optional[float]* | :heavy_minus_sign: | Cost of the request in credits | 0.001 | +| `search_units` | *Optional[int]* | :heavy_minus_sign: | Number of search units consumed (Cohere billing) | 1 | +| `total_tokens` | *Optional[int]* | :heavy_minus_sign: | Total number of tokens used | 150 | \ No newline at end of file diff --git a/docs/operations/createresponsesglobals.mdx b/docs/operations/createresponsesglobals.mdx index 01ef20258..60b3ee5d2 100644 --- a/docs/operations/createresponsesglobals.mdx +++ b/docs/operations/createresponsesglobals.mdx @@ -6,6 +6,6 @@ title: "CreateResponsesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createresponsesrequest.mdx b/docs/operations/createresponsesrequest.mdx index c71432404..bd72e62c2 100644 --- a/docs/operations/createresponsesrequest.mdx +++ b/docs/operations/createresponsesrequest.mdx @@ -6,8 +6,8 @@ title: "CreateResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../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 | -| `responses_request` | [components.ResponsesRequest](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../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 | +| `responses_request` | [components.ResponsesRequest](../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/operations/createscimgroupmappingglobals.mdx b/docs/operations/createscimgroupmappingglobals.mdx index 30306ae2c..ee1187f7f 100644 --- a/docs/operations/createscimgroupmappingglobals.mdx +++ b/docs/operations/createscimgroupmappingglobals.mdx @@ -6,6 +6,6 @@ title: "CreateScimGroupMappingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createscimgroupmappingrequest.mdx b/docs/operations/createscimgroupmappingrequest.mdx index 6273a9d78..c5b268ab4 100644 --- a/docs/operations/createscimgroupmappingrequest.mdx +++ b/docs/operations/createscimgroupmappingrequest.mdx @@ -6,7 +6,7 @@ title: "CreateScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `create_scim_group_mapping_request` | [components.CreateScimGroupMappingRequest](../components/createscimgroupmappingrequest.mdx) | ✅ | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `create_scim_group_mapping_request` | [components.CreateScimGroupMappingRequest](../components/createscimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/createscimsyncjobglobals.mdx b/docs/operations/createscimsyncjobglobals.mdx index 7a32a00bc..5a954d8d9 100644 --- a/docs/operations/createscimsyncjobglobals.mdx +++ b/docs/operations/createscimsyncjobglobals.mdx @@ -6,6 +6,6 @@ title: "CreateScimSyncJobGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createscimsyncjobrequest.mdx b/docs/operations/createscimsyncjobrequest.mdx index 4254d4dea..46f2d75c1 100644 --- a/docs/operations/createscimsyncjobrequest.mdx +++ b/docs/operations/createscimsyncjobrequest.mdx @@ -6,6 +6,6 @@ title: "CreateScimSyncJobRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createscimsyncjobresponse.mdx b/docs/operations/createscimsyncjobresponse.mdx index da5848ef8..1832b155e 100644 --- a/docs/operations/createscimsyncjobresponse.mdx +++ b/docs/operations/createscimsyncjobresponse.mdx @@ -6,5 +6,5 @@ title: "CreateScimSyncJobResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | ✅ | N/A | -| `result` | [components.CreateScimSyncJobResponse](../components/createscimsyncjobresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | +| `result` | [components.CreateScimSyncJobResponse](../components/createscimsyncjobresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/createsystemoneglobals.mdx b/docs/operations/createsystemoneglobals.mdx index 94cdba60a..6fde4d643 100644 --- a/docs/operations/createsystemoneglobals.mdx +++ b/docs/operations/createsystemoneglobals.mdx @@ -6,6 +6,6 @@ title: "CreateSystemoneGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createsystemonerequest.mdx b/docs/operations/createsystemonerequest.mdx index fb32393e8..434fb7f89 100644 --- a/docs/operations/createsystemonerequest.mdx +++ b/docs/operations/createsystemonerequest.mdx @@ -6,7 +6,7 @@ title: "CreateSystemoneRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `decisions_request` | [components.DecisionsRequest](../components/decisionsrequest.mdx) | ✅ | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `decisions_request` | [components.DecisionsRequest](../components/decisionsrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/createvideosglobals.mdx b/docs/operations/createvideosglobals.mdx index 67bd54e9b..be83bcae4 100644 --- a/docs/operations/createvideosglobals.mdx +++ b/docs/operations/createvideosglobals.mdx @@ -6,6 +6,6 @@ title: "CreateVideosGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createvideosrequest.mdx b/docs/operations/createvideosrequest.mdx index c79d703df..2bb242fb9 100644 --- a/docs/operations/createvideosrequest.mdx +++ b/docs/operations/createvideosrequest.mdx @@ -6,7 +6,7 @@ title: "CreateVideosRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `video_generation_request` | [components.VideoGenerationRequest](../components/videogenerationrequest.mdx) | ✅ | N/A | \{
"aspect_ratio": "16:9",
"duration": 8,
"model": "google/veo-3.1",
"prompt": "A serene mountain landscape at sunset",
"resolution": "720p"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `video_generation_request` | [components.VideoGenerationRequest](../components/videogenerationrequest.mdx) | :heavy_check_mark: | N/A | \{
"aspect_ratio": "16:9",
"duration": 8,
"model": "google/veo-3.1",
"prompt": "A serene mountain landscape at sunset",
"resolution": "720p"
} | \ No newline at end of file diff --git a/docs/operations/createworkspaceglobals.mdx b/docs/operations/createworkspaceglobals.mdx index ddce034c8..c85655e73 100644 --- a/docs/operations/createworkspaceglobals.mdx +++ b/docs/operations/createworkspaceglobals.mdx @@ -6,6 +6,6 @@ title: "CreateWorkspaceGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createworkspacerequest.mdx b/docs/operations/createworkspacerequest.mdx index cf085822c..c4c5d7a85 100644 --- a/docs/operations/createworkspacerequest.mdx +++ b/docs/operations/createworkspacerequest.mdx @@ -6,7 +6,7 @@ title: "CreateWorkspaceRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_workspace_request` | [components.CreateWorkspaceRequest](../components/createworkspacerequest.mdx) | ✅ | N/A | \{
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"name": "Production",
"slug": "production"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_workspace_request` | [components.CreateWorkspaceRequest](../components/createworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"name": "Production",
"slug": "production"
} | \ No newline at end of file diff --git a/docs/operations/deletebatchglobals.mdx b/docs/operations/deletebatchglobals.mdx index 3bbe27823..ab6c9c87c 100644 --- a/docs/operations/deletebatchglobals.mdx +++ b/docs/operations/deletebatchglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteBatchGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletebatchrequest.mdx b/docs/operations/deletebatchrequest.mdx index 407d7a96c..4733d5e1c 100644 --- a/docs/operations/deletebatchrequest.mdx +++ b/docs/operations/deletebatchrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteBatchRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/operations/deletebyokkeyglobals.mdx b/docs/operations/deletebyokkeyglobals.mdx index dc9abf920..fa05fb4e1 100644 --- a/docs/operations/deletebyokkeyglobals.mdx +++ b/docs/operations/deletebyokkeyglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteBYOKKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletebyokkeyrequest.mdx b/docs/operations/deletebyokkeyrequest.mdx index 28b7cc22b..7fdac9559 100644 --- a/docs/operations/deletebyokkeyrequest.mdx +++ b/docs/operations/deletebyokkeyrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/operations/deleteenduserglobals.mdx b/docs/operations/deleteenduserglobals.mdx index 82a6d0230..07094eff6 100644 --- a/docs/operations/deleteenduserglobals.mdx +++ b/docs/operations/deleteenduserglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteEndUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteenduserrequest.mdx b/docs/operations/deleteenduserrequest.mdx index d26781bef..39556c28d 100644 --- a/docs/operations/deleteenduserrequest.mdx +++ b/docs/operations/deleteenduserrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `user` | *str* | ✅ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `user` | *str* | :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/operations/deletefileglobals.mdx b/docs/operations/deletefileglobals.mdx index e0c3809a7..7cab840ae 100644 --- a/docs/operations/deletefileglobals.mdx +++ b/docs/operations/deletefileglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteFileGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletefilerequest.mdx b/docs/operations/deletefilerequest.mdx index 436907384..acff81d0d 100644 --- a/docs/operations/deletefilerequest.mdx +++ b/docs/operations/deletefilerequest.mdx @@ -6,9 +6,9 @@ title: "DeleteFileRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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/operations/deleteguardrailglobals.mdx b/docs/operations/deleteguardrailglobals.mdx index 85fce122b..0c506f590 100644 --- a/docs/operations/deleteguardrailglobals.mdx +++ b/docs/operations/deleteguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteguardrailrequest.mdx b/docs/operations/deleteguardrailrequest.mdx index 2e11eee4c..ba80054b8 100644 --- a/docs/operations/deleteguardrailrequest.mdx +++ b/docs/operations/deleteguardrailrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :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/operations/deleteinternglobals.mdx b/docs/operations/deleteinternglobals.mdx index 52a4af8e7..fd39b2b51 100644 --- a/docs/operations/deleteinternglobals.mdx +++ b/docs/operations/deleteinternglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteinternrequest.mdx b/docs/operations/deleteinternrequest.mdx index c4980d4d7..0ed033d7e 100644 --- a/docs/operations/deleteinternrequest.mdx +++ b/docs/operations/deleteinternrequest.mdx @@ -6,8 +6,8 @@ title: "DeleteInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `delete_intern_request` | [components.DeleteInternRequest](../components/deleteinternrequest.mdx) | ✅ | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `delete_intern_request` | [components.DeleteInternRequest](../components/deleteinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file diff --git a/docs/operations/deleteinternvaultsecretglobals.mdx b/docs/operations/deleteinternvaultsecretglobals.mdx index 2be53f3ba..4a262e0b4 100644 --- a/docs/operations/deleteinternvaultsecretglobals.mdx +++ b/docs/operations/deleteinternvaultsecretglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteInternVaultSecretGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteinternvaultsecretrequest.mdx b/docs/operations/deleteinternvaultsecretrequest.mdx index 1d5b9c794..2107702f7 100644 --- a/docs/operations/deleteinternvaultsecretrequest.mdx +++ b/docs/operations/deleteinternvaultsecretrequest.mdx @@ -6,8 +6,8 @@ title: "DeleteInternVaultSecretRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *str* | ✅ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *str* | :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/operations/deletekeysglobals.mdx b/docs/operations/deletekeysglobals.mdx index 02bbb4ede..e89ca07d0 100644 --- a/docs/operations/deletekeysglobals.mdx +++ b/docs/operations/deletekeysglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteKeysGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletekeysrequest.mdx b/docs/operations/deletekeysrequest.mdx index 5561fb7b8..f7ef7a946 100644 --- a/docs/operations/deletekeysrequest.mdx +++ b/docs/operations/deletekeysrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *str* | ✅ | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/operations/deletekeysresponse.mdx b/docs/operations/deletekeysresponse.mdx index 0dc0c3d83..5e83f2662 100644 --- a/docs/operations/deletekeysresponse.mdx +++ b/docs/operations/deletekeysresponse.mdx @@ -9,4 +9,4 @@ API key deleted successfully | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `deleted` | *Literal[True]* | ✅ | Confirmation that the API key was deleted | true | \ No newline at end of file +| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/docs/operations/deleteobservabilitydestinationglobals.mdx b/docs/operations/deleteobservabilitydestinationglobals.mdx index b3aa547df..14ee5de06 100644 --- a/docs/operations/deleteobservabilitydestinationglobals.mdx +++ b/docs/operations/deleteobservabilitydestinationglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteObservabilityDestinationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteobservabilitydestinationrequest.mdx b/docs/operations/deleteobservabilitydestinationrequest.mdx index dc61577c3..6dee392d1 100644 --- a/docs/operations/deleteobservabilitydestinationrequest.mdx +++ b/docs/operations/deleteobservabilitydestinationrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/operations/deleteprivateendpointglobals.mdx b/docs/operations/deleteprivateendpointglobals.mdx index 633c4e34e..8d1c1ca0e 100644 --- a/docs/operations/deleteprivateendpointglobals.mdx +++ b/docs/operations/deleteprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "DeletePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteprivateendpointrequest.mdx b/docs/operations/deleteprivateendpointrequest.mdx index 0adef6c76..81a137ab9 100644 --- a/docs/operations/deleteprivateendpointrequest.mdx +++ b/docs/operations/deleteprivateendpointrequest.mdx @@ -6,8 +6,8 @@ title: "DeletePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `draft_only` | [Optional[operations.DraftOnly]](../operations/draftonly.mdx) | ➖ | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `draft_only` | [Optional[operations.DraftOnly]](../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/operations/deletescimgroupmappingglobals.mdx b/docs/operations/deletescimgroupmappingglobals.mdx index ad2a66e44..098b906f6 100644 --- a/docs/operations/deletescimgroupmappingglobals.mdx +++ b/docs/operations/deletescimgroupmappingglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteScimGroupMappingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletescimgroupmappingrequest.mdx b/docs/operations/deletescimgroupmappingrequest.mdx index 6e2d4f52d..44e2e267a 100644 --- a/docs/operations/deletescimgroupmappingrequest.mdx +++ b/docs/operations/deletescimgroupmappingrequest.mdx @@ -6,8 +6,8 @@ title: "DeleteScimGroupMappingRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | N/A | | -| `keep_members` | [operations.KeepMembers](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `keep_members` | [operations.KeepMembers](../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/operations/deletevaultsecretglobals.mdx b/docs/operations/deletevaultsecretglobals.mdx index c6c4e88b1..1e2f71a1e 100644 --- a/docs/operations/deletevaultsecretglobals.mdx +++ b/docs/operations/deletevaultsecretglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteVaultSecretGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletevaultsecretrequest.mdx b/docs/operations/deletevaultsecretrequest.mdx index e82e0862b..ea844c458 100644 --- a/docs/operations/deletevaultsecretrequest.mdx +++ b/docs/operations/deletevaultsecretrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteVaultSecretRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `name` | *str* | ✅ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `name` | *str* | :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/operations/deleteworkspacebudgetglobals.mdx b/docs/operations/deleteworkspacebudgetglobals.mdx index 7e3c9dbc3..f0aff8192 100644 --- a/docs/operations/deleteworkspacebudgetglobals.mdx +++ b/docs/operations/deleteworkspacebudgetglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteWorkspaceBudgetGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteworkspacebudgetrequest.mdx b/docs/operations/deleteworkspacebudgetrequest.mdx index d7188c892..3470cc03c 100644 --- a/docs/operations/deleteworkspacebudgetrequest.mdx +++ b/docs/operations/deleteworkspacebudgetrequest.mdx @@ -6,8 +6,8 @@ title: "DeleteWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../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/operations/deleteworkspaceglobals.mdx b/docs/operations/deleteworkspaceglobals.mdx index a08d49cb8..c7f6f46cb 100644 --- a/docs/operations/deleteworkspaceglobals.mdx +++ b/docs/operations/deleteworkspaceglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteWorkspaceGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteworkspacerequest.mdx b/docs/operations/deleteworkspacerequest.mdx index ea77d6f6e..abd7fdefd 100644 --- a/docs/operations/deleteworkspacerequest.mdx +++ b/docs/operations/deleteworkspacerequest.mdx @@ -6,8 +6,8 @@ title: "DeleteWorkspaceRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `confirm_default_workspace_deletion` | *Optional[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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `confirm_default_workspace_deletion` | *Optional[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/operations/dimension.mdx b/docs/operations/dimension.mdx index 202615f87..3659423d8 100644 --- a/docs/operations/dimension.mdx +++ b/docs/operations/dimension.mdx @@ -6,5 +6,5 @@ title: "Dimension" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `display_label` | *str* | ✅ | Human-readable label | Model | -| `name` | *str* | ✅ | Dimension identifier used in query requests | model | \ No newline at end of file +| `display_label` | *str* | :heavy_check_mark: | Human-readable label | Model | +| `name` | *str* | :heavy_check_mark: | Dimension identifier used in query requests | model | \ No newline at end of file diff --git a/docs/operations/disableprivateendpointglobals.mdx b/docs/operations/disableprivateendpointglobals.mdx index 6c3e78d7c..5ce04b276 100644 --- a/docs/operations/disableprivateendpointglobals.mdx +++ b/docs/operations/disableprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "DisablePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/disableprivateendpointrequest.mdx b/docs/operations/disableprivateendpointrequest.mdx index 41f3210a7..a7188f2b0 100644 --- a/docs/operations/disableprivateendpointrequest.mdx +++ b/docs/operations/disableprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "DisablePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/operations/documentrequest.mdx b/docs/operations/documentrequest.mdx index a152c2e2e..4c0dd9f85 100644 --- a/docs/operations/documentrequest.mdx +++ b/docs/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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | The document text | AI enables robots to perceive, plan, and act autonomously. | \ No newline at end of file +| `image` | *Optional[str]* | :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` | *Optional[str]* | :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/operations/documentresponse.mdx b/docs/operations/documentresponse.mdx index 13011de0c..5dc0d7b0c 100644 --- a/docs/operations/documentresponse.mdx +++ b/docs/operations/documentresponse.mdx @@ -9,5 +9,5 @@ The document object echoing the original input (text and/or image) | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `image` | *Optional[str]* | ➖ | The image (URL or data URI) from the original document | https://example.com/image.png | -| `text` | *Optional[str]* | ➖ | The document text | Paris is the capital of France. | \ No newline at end of file +| `image` | *Optional[str]* | :heavy_minus_sign: | The image (URL or data URI) from the original document | https://example.com/image.png | +| `text` | *Optional[str]* | :heavy_minus_sign: | The document text | Paris is the capital of France. | \ No newline at end of file diff --git a/docs/operations/downloadcontainerfilecontentglobals.mdx b/docs/operations/downloadcontainerfilecontentglobals.mdx index 35d8285d6..630f5406b 100644 --- a/docs/operations/downloadcontainerfilecontentglobals.mdx +++ b/docs/operations/downloadcontainerfilecontentglobals.mdx @@ -6,6 +6,6 @@ title: "DownloadContainerFileContentGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/downloadcontainerfilecontentrequest.mdx b/docs/operations/downloadcontainerfilecontentrequest.mdx index 86948d119..19374f28d 100644 --- a/docs/operations/downloadcontainerfilecontentrequest.mdx +++ b/docs/operations/downloadcontainerfilecontentrequest.mdx @@ -6,8 +6,8 @@ title: "DownloadContainerFileContentRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `container_id` | *str* | ✅ | 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 | -| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `container_id` | *str* | :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 | +| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/operations/downloadfilecontentglobals.mdx b/docs/operations/downloadfilecontentglobals.mdx index 653fff7e7..8415a6685 100644 --- a/docs/operations/downloadfilecontentglobals.mdx +++ b/docs/operations/downloadfilecontentglobals.mdx @@ -6,6 +6,6 @@ title: "DownloadFileContentGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/downloadfilecontentrequest.mdx b/docs/operations/downloadfilecontentrequest.mdx index 25e247b97..4e0f83f37 100644 --- a/docs/operations/downloadfilecontentrequest.mdx +++ b/docs/operations/downloadfilecontentrequest.mdx @@ -6,9 +6,9 @@ title: "DownloadFileContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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/operations/enableprivateendpointglobals.mdx b/docs/operations/enableprivateendpointglobals.mdx index 406f3f2ad..8ff7549f8 100644 --- a/docs/operations/enableprivateendpointglobals.mdx +++ b/docs/operations/enableprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "EnablePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/enableprivateendpointrequest.mdx b/docs/operations/enableprivateendpointrequest.mdx index 1fa4075c1..6ab00a007 100644 --- a/docs/operations/enableprivateendpointrequest.mdx +++ b/docs/operations/enableprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "EnablePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/operations/exchangeauthcodeforapikeyglobals.mdx b/docs/operations/exchangeauthcodeforapikeyglobals.mdx index 87e1d20d3..3e9fa3231 100644 --- a/docs/operations/exchangeauthcodeforapikeyglobals.mdx +++ b/docs/operations/exchangeauthcodeforapikeyglobals.mdx @@ -6,6 +6,6 @@ title: "ExchangeAuthCodeForAPIKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/exchangeauthcodeforapikeyrequest.mdx b/docs/operations/exchangeauthcodeforapikeyrequest.mdx index 6638636d8..a52648cda 100644 --- a/docs/operations/exchangeauthcodeforapikeyrequest.mdx +++ b/docs/operations/exchangeauthcodeforapikeyrequest.mdx @@ -6,7 +6,7 @@ title: "ExchangeAuthCodeForAPIKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](../operations/exchangeauthcodeforapikeyrequestbody.mdx) | ✅ | N/A | \{
"code": "auth_code_abc123def456",
"code_challenge_method": "S256",
"code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](../operations/exchangeauthcodeforapikeyrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"code": "auth_code_abc123def456",
"code_challenge_method": "S256",
"code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"
} | \ No newline at end of file diff --git a/docs/operations/exchangeauthcodeforapikeyrequestbody.mdx b/docs/operations/exchangeauthcodeforapikeyrequestbody.mdx index 0075cad86..27265f4f7 100644 --- a/docs/operations/exchangeauthcodeforapikeyrequestbody.mdx +++ b/docs/operations/exchangeauthcodeforapikeyrequestbody.mdx @@ -6,6 +6,6 @@ title: "ExchangeAuthCodeForAPIKeyRequestBody" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `code` | *str* | ✅ | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | -| `code_verifier` | *Optional[str]* | ➖ | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | \ No newline at end of file +| `code` | *str* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | +| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | +| `code_verifier` | *Optional[str]* | :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/operations/exchangeauthcodeforapikeyresponse.mdx b/docs/operations/exchangeauthcodeforapikeyresponse.mdx index 06952934b..2642f99d7 100644 --- a/docs/operations/exchangeauthcodeforapikeyresponse.mdx +++ b/docs/operations/exchangeauthcodeforapikeyresponse.mdx @@ -9,5 +9,5 @@ Successfully exchanged code for an API key | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *str* | ✅ | The API key to use for OpenRouter requests | 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 | -| `user_id` | *Nullable[str]* | ✅ | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file +| `key` | *str* | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | +| `user_id` | *Nullable[str]* | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/docs/operations/external.mdx b/docs/operations/external.mdx index f8ac0a60f..a9bac3e77 100644 --- a/docs/operations/external.mdx +++ b/docs/operations/external.mdx @@ -9,5 +9,5 @@ Optional partner-defined identity associated with the created API key. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *Optional[str]* | ➖ | 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` | *str* | ✅ | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file +| `api_key` | *Optional[str]* | :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` | *str* | :heavy_check_mark: | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file diff --git a/docs/operations/filter_.mdx b/docs/operations/filter_.mdx index 9ca17c1dc..8a0c5f32e 100644 --- a/docs/operations/filter_.mdx +++ b/docs/operations/filter_.mdx @@ -6,7 +6,7 @@ title: "Filter" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field` | *str* | ✅ | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | -| `include_unset` | *Optional[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` | *str* | ✅ | Filter operator | eq | -| `value` | [operations.Value1](../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` | *str* | :heavy_check_mark: | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | +| `include_unset` | *Optional[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` | *str* | :heavy_check_mark: | Filter operator | eq | +| `value` | [operations.Value1](../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/operations/getanalyticsmetadata.mdx b/docs/operations/getanalyticsmetadata.mdx index 31d0a8f2e..6eacfe52c 100644 --- a/docs/operations/getanalyticsmetadata.mdx +++ b/docs/operations/getanalyticsmetadata.mdx @@ -6,7 +6,7 @@ title: "GetAnalyticsMetaData" | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `dimensions` | List[[operations.Dimension](../operations/dimension.mdx)] | ✅ | N/A | -| `granularities` | List[[operations.Granularity](../operations/granularity.mdx)] | ✅ | N/A | -| `metrics` | List[[operations.Metric](../operations/metric.mdx)] | ✅ | N/A | -| `operators` | List[[operations.Operator](../operations/operator.mdx)] | ✅ | N/A | \ No newline at end of file +| `dimensions` | List[[operations.Dimension](../operations/dimension.mdx)] | :heavy_check_mark: | N/A | +| `granularities` | List[[operations.Granularity](../operations/granularity.mdx)] | :heavy_check_mark: | N/A | +| `metrics` | List[[operations.Metric](../operations/metric.mdx)] | :heavy_check_mark: | N/A | +| `operators` | List[[operations.Operator](../operations/operator.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/getanalyticsmetaglobals.mdx b/docs/operations/getanalyticsmetaglobals.mdx index 79af35683..a44950e11 100644 --- a/docs/operations/getanalyticsmetaglobals.mdx +++ b/docs/operations/getanalyticsmetaglobals.mdx @@ -6,6 +6,6 @@ title: "GetAnalyticsMetaGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getanalyticsmetarequest.mdx b/docs/operations/getanalyticsmetarequest.mdx index 62cd80412..9ca0cb3d9 100644 --- a/docs/operations/getanalyticsmetarequest.mdx +++ b/docs/operations/getanalyticsmetarequest.mdx @@ -6,6 +6,6 @@ title: "GetAnalyticsMetaRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getanalyticsmetaresponse.mdx b/docs/operations/getanalyticsmetaresponse.mdx index 6a659d4d9..f2a6915c1 100644 --- a/docs/operations/getanalyticsmetaresponse.mdx +++ b/docs/operations/getanalyticsmetaresponse.mdx @@ -9,4 +9,4 @@ Returns analytics query metadata | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | [operations.GetAnalyticsMetaData](../operations/getanalyticsmetadata.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [operations.GetAnalyticsMetaData](../operations/getanalyticsmetadata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/getapprankingsglobals.mdx b/docs/operations/getapprankingsglobals.mdx index 7be3ca5ac..0dd87c38f 100644 --- a/docs/operations/getapprankingsglobals.mdx +++ b/docs/operations/getapprankingsglobals.mdx @@ -6,6 +6,6 @@ title: "GetAppRankingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getapprankingsrequest.mdx b/docs/operations/getapprankingsrequest.mdx index 28417333c..fb3afc125 100644 --- a/docs/operations/getapprankingsrequest.mdx +++ b/docs/operations/getapprankingsrequest.mdx @@ -6,13 +6,13 @@ title: "GetAppRankingsRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `category` | [Optional[operations.GetAppRankingsCategory]](../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` | [Optional[operations.Subcategory]](../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` | [Optional[operations.GetAppRankingsSort]](../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 | -| `start_date` | *Optional[str]* | ➖ | 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 | -| `end_date` | *Optional[str]* | ➖ | 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` | *Optional[int]* | ➖ | Maximum number of apps to return (1-100). Defaults to 50. | 50 | -| `offset` | *OptionalNullable[int]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `category` | [Optional[operations.GetAppRankingsCategory]](../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` | [Optional[operations.Subcategory]](../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` | [Optional[operations.GetAppRankingsSort]](../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 | +| `start_date` | *Optional[str]* | :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 | +| `end_date` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Maximum number of apps to return (1-100). Defaults to 50. | 50 | +| `offset` | *OptionalNullable[int]* | :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/operations/getapprankingsresponse.mdx b/docs/operations/getapprankingsresponse.mdx index c7566188a..4d8e0195d 100644 --- a/docs/operations/getapprankingsresponse.mdx +++ b/docs/operations/getapprankingsresponse.mdx @@ -6,4 +6,4 @@ title: "GetAppRankingsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.AppRankingsResponse](../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](../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/operations/getbatchesglobals.mdx b/docs/operations/getbatchesglobals.mdx index 023896e2a..0f082c131 100644 --- a/docs/operations/getbatchesglobals.mdx +++ b/docs/operations/getbatchesglobals.mdx @@ -6,6 +6,6 @@ title: "GetBatchesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getbatchesrequest.mdx b/docs/operations/getbatchesrequest.mdx index 93cb14bb4..522a7e42a 100644 --- a/docs/operations/getbatchesrequest.mdx +++ b/docs/operations/getbatchesrequest.mdx @@ -6,7 +6,7 @@ title: "GetBatchesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/operations/getbenchmarksglobals.mdx b/docs/operations/getbenchmarksglobals.mdx index 274aa021a..679923bfb 100644 --- a/docs/operations/getbenchmarksglobals.mdx +++ b/docs/operations/getbenchmarksglobals.mdx @@ -6,6 +6,6 @@ title: "GetBenchmarksGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getbenchmarksrequest.mdx b/docs/operations/getbenchmarksrequest.mdx index ab720f00c..e45dab262 100644 --- a/docs/operations/getbenchmarksrequest.mdx +++ b/docs/operations/getbenchmarksrequest.mdx @@ -6,15 +6,15 @@ title: "GetBenchmarksRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `source` | [Optional[operations.Source]](../operations/source.mdx) | ➖ | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | -| `task_type` | [Optional[operations.TaskType]](../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 | -| `benchmark_type` | [Optional[operations.BenchmarkType]](../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 | -| `include_run_config` | *Optional[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 | -| `search_engine` | *Optional[str]* | ➖ | OpenRouter search benchmarks only: filter by the search engine used. | exa | -| `search_surface` | [Optional[operations.SearchSurface]](../operations/searchsurface.mdx) | ➖ | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | -| `arena` | [Optional[operations.Arena]](../operations/arena.mdx) | ➖ | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | -| `category` | *Optional[str]* | ➖ | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | -| `max_results` | *Optional[int]* | ➖ | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `source` | [Optional[operations.Source]](../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 | +| `task_type` | [Optional[operations.TaskType]](../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 | +| `benchmark_type` | [Optional[operations.BenchmarkType]](../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 | +| `include_run_config` | *Optional[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 | +| `search_engine` | *Optional[str]* | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the search engine used. | exa | +| `search_surface` | [Optional[operations.SearchSurface]](../operations/searchsurface.mdx) | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | +| `arena` | [Optional[operations.Arena]](../operations/arena.mdx) | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | +| `category` | *Optional[str]* | :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 | +| `max_results` | *Optional[int]* | :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/operations/getbyokkeyglobals.mdx b/docs/operations/getbyokkeyglobals.mdx index 4acf0c448..02962c394 100644 --- a/docs/operations/getbyokkeyglobals.mdx +++ b/docs/operations/getbyokkeyglobals.mdx @@ -6,6 +6,6 @@ title: "GetBYOKKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getbyokkeyrequest.mdx b/docs/operations/getbyokkeyrequest.mdx index 7e3535935..7c2582129 100644 --- a/docs/operations/getbyokkeyrequest.mdx +++ b/docs/operations/getbyokkeyrequest.mdx @@ -6,7 +6,7 @@ title: "GetBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/operations/getcontainerfileglobals.mdx b/docs/operations/getcontainerfileglobals.mdx index 136824711..8343594f8 100644 --- a/docs/operations/getcontainerfileglobals.mdx +++ b/docs/operations/getcontainerfileglobals.mdx @@ -6,6 +6,6 @@ title: "GetContainerFileGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcontainerfilerequest.mdx b/docs/operations/getcontainerfilerequest.mdx index f93cbf450..1529bd94e 100644 --- a/docs/operations/getcontainerfilerequest.mdx +++ b/docs/operations/getcontainerfilerequest.mdx @@ -6,8 +6,8 @@ title: "GetContainerFileRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `container_id` | *str* | ✅ | 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 | -| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `container_id` | *str* | :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 | +| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/operations/getcreditsdata.mdx b/docs/operations/getcreditsdata.mdx index e530cf82c..b0a60e0c1 100644 --- a/docs/operations/getcreditsdata.mdx +++ b/docs/operations/getcreditsdata.mdx @@ -6,5 +6,5 @@ title: "GetCreditsData" | Field | Type | Required | Description | Example | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `total_credits` | *float* | ✅ | Total credits purchased | 100.5 | -| `total_usage` | *float* | ✅ | Total credits used | 25.75 | \ No newline at end of file +| `total_credits` | *float* | :heavy_check_mark: | Total credits purchased | 100.5 | +| `total_usage` | *float* | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file diff --git a/docs/operations/getcreditsglobals.mdx b/docs/operations/getcreditsglobals.mdx index 6d68841f0..e31d9868d 100644 --- a/docs/operations/getcreditsglobals.mdx +++ b/docs/operations/getcreditsglobals.mdx @@ -6,6 +6,6 @@ title: "GetCreditsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcreditsrequest.mdx b/docs/operations/getcreditsrequest.mdx index 3480020e4..6e73894ac 100644 --- a/docs/operations/getcreditsrequest.mdx +++ b/docs/operations/getcreditsrequest.mdx @@ -6,6 +6,6 @@ title: "GetCreditsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcreditsresponse.mdx b/docs/operations/getcreditsresponse.mdx index 281e71c1a..1f584bb9e 100644 --- a/docs/operations/getcreditsresponse.mdx +++ b/docs/operations/getcreditsresponse.mdx @@ -9,4 +9,4 @@ Total credits purchased and used | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `data` | [operations.GetCreditsData](../operations/getcreditsdata.mdx) | ✅ | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file +| `data` | [operations.GetCreditsData](../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/operations/getcurrentkeydata.mdx b/docs/operations/getcurrentkeydata.mdx index 9edb39914..33b5cb77d 100644 --- a/docs/operations/getcurrentkeydata.mdx +++ b/docs/operations/getcurrentkeydata.mdx @@ -9,28 +9,28 @@ Current API key information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_data_regions` | List[[operations.AllowedDataRegion](../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"
] | -| `budgets` | List[[components.KeyBudget](../components/keybudget.mdx)] | ✅ | Every budget layer enforcement checks for requests made with this key, in the order it checks them: guardrail budgets, workspace budgets, then the key's own limit. Empty when nothing is budgeted. `effective_budget` is the budget that blocks requests first: the entry enforcement rejects on when one is already spent, otherwise the entry with the least `remaining_usd`; null when nothing is budgeted. `limit` and `limit_remaining` above describe only the key's own limit. | [
\{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
}
] | -| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `creator_user_id` | *Nullable[str]* | ✅ | 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 | -| `effective_budget` | [Nullable[components.KeyBudget]](../components/keybudget.mdx) | ✅ | N/A | \{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
} | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `free_model_daily_requests` | [components.FreeModelDailyRequests](../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
} | -| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `is_free_tier` | *bool* | ✅ | Whether this is a free tier API key | false | -| `is_management_key` | *bool* | ✅ | Whether this is a management key | false | -| ~~`is_provisioning_key`~~ | *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` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | -| `organization_id` | *Nullable[str]* | ✅ | The ID of the organization that owns this API key, or null when an individual account owns it. | null | -| ~~`rate_limit`~~ | [operations.RateLimit](../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` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *Nullable[str]* | ✅ | 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 +| `allowed_data_regions` | List[[operations.AllowedDataRegion](../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"
] | +| `budgets` | List[[components.KeyBudget](../components/keybudget.mdx)] | :heavy_check_mark: | Every budget layer enforcement checks for requests made with this key, in the order it checks them: guardrail budgets, workspace budgets, then the key's own limit. Empty when nothing is budgeted. `effective_budget` is the budget that blocks requests first: the entry enforcement rejects on when one is already spent, otherwise the entry with the least `remaining_usd`; null when nothing is budgeted. `limit` and `limit_remaining` above describe only the key's own limit. | [
\{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
}
] | +| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `creator_user_id` | *Nullable[str]* | :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 | +| `effective_budget` | [Nullable[components.KeyBudget]](../components/keybudget.mdx) | :heavy_check_mark: | N/A | \{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
} | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `free_model_daily_requests` | [components.FreeModelDailyRequests](../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
} | +| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `is_free_tier` | *bool* | :heavy_check_mark: | Whether this is a free tier API key | false | +| `is_management_key` | *bool* | :heavy_check_mark: | Whether this is a management key | false | +| ~~`is_provisioning_key`~~ | *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` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `organization_id` | *Nullable[str]* | :heavy_check_mark: | The ID of the organization that owns this API key, or null when an individual account owns it. | null | +| ~~`rate_limit`~~ | [operations.RateLimit](../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` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *Nullable[str]* | :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/operations/getcurrentkeyglobals.mdx b/docs/operations/getcurrentkeyglobals.mdx index eeaa280d8..784c3ac35 100644 --- a/docs/operations/getcurrentkeyglobals.mdx +++ b/docs/operations/getcurrentkeyglobals.mdx @@ -6,6 +6,6 @@ title: "GetCurrentKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcurrentkeyrequest.mdx b/docs/operations/getcurrentkeyrequest.mdx index a0f691dec..720e0e050 100644 --- a/docs/operations/getcurrentkeyrequest.mdx +++ b/docs/operations/getcurrentkeyrequest.mdx @@ -6,6 +6,6 @@ title: "GetCurrentKeyRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcurrentkeyresponse.mdx b/docs/operations/getcurrentkeyresponse.mdx index 3bb4a580b..bf0f6a34d 100644 --- a/docs/operations/getcurrentkeyresponse.mdx +++ b/docs/operations/getcurrentkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetCurrentKeyData](../operations/getcurrentkeydata.mdx) | ✅ | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"budgets": [
\{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
}
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"effective_budget": \{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
},
"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](../operations/getcurrentkeydata.mdx) | :heavy_check_mark: | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"budgets": [
\{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
}
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"effective_budget": \{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
},
"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/operations/getenduserglobals.mdx b/docs/operations/getenduserglobals.mdx index 2b3180e07..9ec66ba16 100644 --- a/docs/operations/getenduserglobals.mdx +++ b/docs/operations/getenduserglobals.mdx @@ -6,6 +6,6 @@ title: "GetEndUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getenduserrequest.mdx b/docs/operations/getenduserrequest.mdx index 51b72505b..1e234b288 100644 --- a/docs/operations/getenduserrequest.mdx +++ b/docs/operations/getenduserrequest.mdx @@ -6,7 +6,7 @@ title: "GetEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `user` | *str* | ✅ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `user` | *str* | :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/operations/getfilemetadataglobals.mdx b/docs/operations/getfilemetadataglobals.mdx index 155391a10..4b9270d76 100644 --- a/docs/operations/getfilemetadataglobals.mdx +++ b/docs/operations/getfilemetadataglobals.mdx @@ -6,6 +6,6 @@ title: "GetFileMetadataGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getfilemetadatarequest.mdx b/docs/operations/getfilemetadatarequest.mdx index a3de05a5a..429a0f547 100644 --- a/docs/operations/getfilemetadatarequest.mdx +++ b/docs/operations/getfilemetadatarequest.mdx @@ -6,9 +6,9 @@ title: "GetFileMetadataRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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/operations/getgenerationglobals.mdx b/docs/operations/getgenerationglobals.mdx index 188c89473..450a95a84 100644 --- a/docs/operations/getgenerationglobals.mdx +++ b/docs/operations/getgenerationglobals.mdx @@ -6,6 +6,6 @@ title: "GetGenerationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getgenerationrequest.mdx b/docs/operations/getgenerationrequest.mdx index 1164a497e..318c98012 100644 --- a/docs/operations/getgenerationrequest.mdx +++ b/docs/operations/getgenerationrequest.mdx @@ -6,7 +6,7 @@ title: "GetGenerationRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/operations/getguardrailglobals.mdx b/docs/operations/getguardrailglobals.mdx index 6b885f099..3cd67137d 100644 --- a/docs/operations/getguardrailglobals.mdx +++ b/docs/operations/getguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "GetGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getguardrailrequest.mdx b/docs/operations/getguardrailrequest.mdx index 3c44f43c1..15bebf62b 100644 --- a/docs/operations/getguardrailrequest.mdx +++ b/docs/operations/getguardrailrequest.mdx @@ -6,7 +6,7 @@ title: "GetGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :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/operations/getinterndaemonaccessglobals.mdx b/docs/operations/getinterndaemonaccessglobals.mdx index d26998946..95abed7a1 100644 --- a/docs/operations/getinterndaemonaccessglobals.mdx +++ b/docs/operations/getinterndaemonaccessglobals.mdx @@ -6,6 +6,6 @@ title: "GetInternDaemonAccessGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getinterndaemonaccessrequest.mdx b/docs/operations/getinterndaemonaccessrequest.mdx index 169fa7676..e2035a9f0 100644 --- a/docs/operations/getinterndaemonaccessrequest.mdx +++ b/docs/operations/getinterndaemonaccessrequest.mdx @@ -6,7 +6,7 @@ title: "GetInternDaemonAccessRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :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/operations/getinterndaemonglobals.mdx b/docs/operations/getinterndaemonglobals.mdx index 5cb15c10c..b2ba0d173 100644 --- a/docs/operations/getinterndaemonglobals.mdx +++ b/docs/operations/getinterndaemonglobals.mdx @@ -6,6 +6,6 @@ title: "GetInternDaemonGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getinterndaemonrequest.mdx b/docs/operations/getinterndaemonrequest.mdx index b21897206..cdfbaafc1 100644 --- a/docs/operations/getinterndaemonrequest.mdx +++ b/docs/operations/getinterndaemonrequest.mdx @@ -6,7 +6,7 @@ title: "GetInternDaemonRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :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/operations/getinternglobals.mdx b/docs/operations/getinternglobals.mdx index a524a18a9..118bb0d2f 100644 --- a/docs/operations/getinternglobals.mdx +++ b/docs/operations/getinternglobals.mdx @@ -6,6 +6,6 @@ title: "GetInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getinternrequest.mdx b/docs/operations/getinternrequest.mdx index 3b516a3b1..cd83fdf51 100644 --- a/docs/operations/getinternrequest.mdx +++ b/docs/operations/getinternrequest.mdx @@ -6,7 +6,7 @@ title: "GetInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :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/operations/getkeydata.mdx b/docs/operations/getkeydata.mdx index f93cde1d0..3ad8cfab8 100644 --- a/docs/operations/getkeydata.mdx +++ b/docs/operations/getkeydata.mdx @@ -9,26 +9,26 @@ The API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | ✅ | 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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `external_user` | *Nullable[str]* | ✅ | Partner's end-user identifier used for attribution. | null | -| `hash` | *str* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | -| `name` | *str* | ✅ | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creator_user_id` | *Nullable[str]* | :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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `external_user` | *Nullable[str]* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | +| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | +| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *str* | :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/operations/getkeyglobals.mdx b/docs/operations/getkeyglobals.mdx index ebc8f56f3..59d0a567f 100644 --- a/docs/operations/getkeyglobals.mdx +++ b/docs/operations/getkeyglobals.mdx @@ -6,6 +6,6 @@ title: "GetKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getkeyrequest.mdx b/docs/operations/getkeyrequest.mdx index 3f13c8e29..917f40732 100644 --- a/docs/operations/getkeyrequest.mdx +++ b/docs/operations/getkeyrequest.mdx @@ -6,7 +6,7 @@ title: "GetKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *str* | ✅ | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/operations/getkeyresponse.mdx b/docs/operations/getkeyresponse.mdx index 2fb830051..962912273 100644 --- a/docs/operations/getkeyresponse.mdx +++ b/docs/operations/getkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetKeyData](../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](../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/operations/getmodelglobals.mdx b/docs/operations/getmodelglobals.mdx index 66f24f7f1..e253e0265 100644 --- a/docs/operations/getmodelglobals.mdx +++ b/docs/operations/getmodelglobals.mdx @@ -6,6 +6,6 @@ title: "GetModelGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getmodelrequest.mdx b/docs/operations/getmodelrequest.mdx index 92fb4ee45..860150ab6 100644 --- a/docs/operations/getmodelrequest.mdx +++ b/docs/operations/getmodelrequest.mdx @@ -6,8 +6,8 @@ title: "GetModelRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *str* | ✅ | The author/organization of the model | openai | -| `slug` | *str* | ✅ | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | +| `slug` | *str* | :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/operations/getmodelsglobals.mdx b/docs/operations/getmodelsglobals.mdx index 0f723aca8..e6beafcf1 100644 --- a/docs/operations/getmodelsglobals.mdx +++ b/docs/operations/getmodelsglobals.mdx @@ -6,6 +6,6 @@ title: "GetModelsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getmodelsrequest.mdx b/docs/operations/getmodelsrequest.mdx index 720c6a15c..95e4b488f 100644 --- a/docs/operations/getmodelsrequest.mdx +++ b/docs/operations/getmodelsrequest.mdx @@ -6,35 +6,35 @@ title: "GetModelsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `category` | [Optional[operations.GetModelsCategory]](../operations/getmodelscategory.mdx) | ➖ | Filter models by use case category | programming | -| `supported_parameters` | *Optional[str]* | ➖ | Filter models by supported parameter (comma-separated) | temperature | -| `output_modalities` | *Optional[str]* | ➖ | 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` | [Optional[operations.GetModelsSort]](../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` | *Optional[str]* | ➖ | Free-text search by model name or slug. | gpt-4 | -| `input_modalities` | *Optional[str]* | ➖ | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | -| `context` | *Optional[int]* | ➖ | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | -| `min_price` | *OptionalNullable[float]* | ➖ | Minimum prompt price in $/M tokens. | 0 | -| `max_price` | *OptionalNullable[float]* | ➖ | Maximum prompt price in $/M tokens. | 10 | -| `arch` | *Optional[str]* | ➖ | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | -| `model_authors` | *Optional[str]* | ➖ | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | -| `providers` | *Optional[str]* | ➖ | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | -| `distillable` | [Optional[operations.Distillable]](../operations/distillable.mdx) | ➖ | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | -| `zdr` | [Optional[operations.Zdr]](../operations/zdr.mdx) | ➖ | When set to "true", return only models with zero data retention endpoints. | true | -| `region` | [Optional[operations.Region]](../operations/region.mdx) | ➖ | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | -| `min_output_price` | *OptionalNullable[float]* | ➖ | Minimum completion (output) price in $/M tokens. | 0 | -| `max_output_price` | *OptionalNullable[float]* | ➖ | Maximum completion (output) price in $/M tokens. | 10 | -| `min_age_days` | *OptionalNullable[int]* | ➖ | Minimum model age in days since its creation date. | 0 | -| `max_age_days` | *OptionalNullable[int]* | ➖ | Maximum model age in days since its creation date. | 90 | -| `min_intelligence_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis intelligence index. | 50 | -| `max_intelligence_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis intelligence index. | 100 | -| `min_coding_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis coding index. | 50 | -| `max_coding_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis coding index. | 100 | -| `min_agentic_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis agentic index. | 50 | -| `max_agentic_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis agentic index. | 100 | -| `min_tool_success_rate` | *OptionalNullable[float]* | ➖ | 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 | -| `max_tool_success_rate` | *OptionalNullable[float]* | ➖ | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | :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` | [Optional[operations.GetModelsCategory]](../operations/getmodelscategory.mdx) | :heavy_minus_sign: | Filter models by use case category | programming | +| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | +| `output_modalities` | *Optional[str]* | :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` | [Optional[operations.GetModelsSort]](../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` | *Optional[str]* | :heavy_minus_sign: | Free-text search by model name or slug. | gpt-4 | +| `input_modalities` | *Optional[str]* | :heavy_minus_sign: | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | +| `context` | *Optional[int]* | :heavy_minus_sign: | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | +| `min_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum prompt price in $/M tokens. | 0 | +| `max_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum prompt price in $/M tokens. | 10 | +| `arch` | *Optional[str]* | :heavy_minus_sign: | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | +| `model_authors` | *Optional[str]* | :heavy_minus_sign: | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | +| `providers` | *Optional[str]* | :heavy_minus_sign: | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | +| `distillable` | [Optional[operations.Distillable]](../operations/distillable.mdx) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | +| `zdr` | [Optional[operations.Zdr]](../operations/zdr.mdx) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | +| `region` | [Optional[operations.Region]](../operations/region.mdx) | :heavy_minus_sign: | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | +| `min_output_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum completion (output) price in $/M tokens. | 0 | +| `max_output_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum completion (output) price in $/M tokens. | 10 | +| `min_age_days` | *OptionalNullable[int]* | :heavy_minus_sign: | Minimum model age in days since its creation date. | 0 | +| `max_age_days` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum model age in days since its creation date. | 90 | +| `min_intelligence_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis intelligence index. | 50 | +| `max_intelligence_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis intelligence index. | 100 | +| `min_coding_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis coding index. | 50 | +| `max_coding_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis coding index. | 100 | +| `min_agentic_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis agentic index. | 50 | +| `max_agentic_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis agentic index. | 100 | +| `min_tool_success_rate` | *OptionalNullable[float]* | :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 | +| `max_tool_success_rate` | *OptionalNullable[float]* | :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/operations/getmodelsresponse.mdx b/docs/operations/getmodelsresponse.mdx index c420651f2..c7353f31e 100644 --- a/docs/operations/getmodelsresponse.mdx +++ b/docs/operations/getmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "GetModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ModelsListResponse](../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](../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/operations/getobservabilitydestinationglobals.mdx b/docs/operations/getobservabilitydestinationglobals.mdx index b7b80f3be..aeec24b09 100644 --- a/docs/operations/getobservabilitydestinationglobals.mdx +++ b/docs/operations/getobservabilitydestinationglobals.mdx @@ -6,6 +6,6 @@ title: "GetObservabilityDestinationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getobservabilitydestinationrequest.mdx b/docs/operations/getobservabilitydestinationrequest.mdx index 402163eaf..39b2655a6 100644 --- a/docs/operations/getobservabilitydestinationrequest.mdx +++ b/docs/operations/getobservabilitydestinationrequest.mdx @@ -6,7 +6,7 @@ title: "GetObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/operations/getorganizationsettingsglobals.mdx b/docs/operations/getorganizationsettingsglobals.mdx index d7b209aa8..0da74f3e2 100644 --- a/docs/operations/getorganizationsettingsglobals.mdx +++ b/docs/operations/getorganizationsettingsglobals.mdx @@ -6,6 +6,6 @@ title: "GetOrganizationSettingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getorganizationsettingsrequest.mdx b/docs/operations/getorganizationsettingsrequest.mdx index 89d9be99a..81b959f54 100644 --- a/docs/operations/getorganizationsettingsrequest.mdx +++ b/docs/operations/getorganizationsettingsrequest.mdx @@ -6,6 +6,6 @@ title: "GetOrganizationSettingsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getorganizationsettingsresponse.mdx b/docs/operations/getorganizationsettingsresponse.mdx index a43f8dab0..240031a50 100644 --- a/docs/operations/getorganizationsettingsresponse.mdx +++ b/docs/operations/getorganizationsettingsresponse.mdx @@ -9,4 +9,4 @@ Organization settings | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [components.OrganizationSettings](../components/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file +| `data` | [components.OrganizationSettings](../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/operations/getpresetglobals.mdx b/docs/operations/getpresetglobals.mdx index e1a943be0..b3e3cb518 100644 --- a/docs/operations/getpresetglobals.mdx +++ b/docs/operations/getpresetglobals.mdx @@ -6,6 +6,6 @@ title: "GetPresetGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getpresetrequest.mdx b/docs/operations/getpresetrequest.mdx index 671a7c545..373839890 100644 --- a/docs/operations/getpresetrequest.mdx +++ b/docs/operations/getpresetrequest.mdx @@ -6,7 +6,7 @@ title: "GetPresetRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file diff --git a/docs/operations/getpresetversionglobals.mdx b/docs/operations/getpresetversionglobals.mdx index dbabdd2fb..55879e9ba 100644 --- a/docs/operations/getpresetversionglobals.mdx +++ b/docs/operations/getpresetversionglobals.mdx @@ -6,6 +6,6 @@ title: "GetPresetVersionGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getpresetversionrequest.mdx b/docs/operations/getpresetversionrequest.mdx index 627d573b1..c7cf40110 100644 --- a/docs/operations/getpresetversionrequest.mdx +++ b/docs/operations/getpresetversionrequest.mdx @@ -6,8 +6,8 @@ title: "GetPresetVersionRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | -| `version` | *str* | ✅ | Version number of the preset. | 1 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `version` | *str* | :heavy_check_mark: | Version number of the preset. | 1 | \ No newline at end of file diff --git a/docs/operations/getprivateendpointglobals.mdx b/docs/operations/getprivateendpointglobals.mdx index 6c1d4444f..81ff79ea5 100644 --- a/docs/operations/getprivateendpointglobals.mdx +++ b/docs/operations/getprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "GetPrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getprivateendpointrequest.mdx b/docs/operations/getprivateendpointrequest.mdx index 6f17bf5aa..eb6aa4354 100644 --- a/docs/operations/getprivateendpointrequest.mdx +++ b/docs/operations/getprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "GetPrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/operations/getrankingsdailyglobals.mdx b/docs/operations/getrankingsdailyglobals.mdx index 954123ff1..4bc1a2bf9 100644 --- a/docs/operations/getrankingsdailyglobals.mdx +++ b/docs/operations/getrankingsdailyglobals.mdx @@ -6,6 +6,6 @@ title: "GetRankingsDailyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getrankingsdailyrequest.mdx b/docs/operations/getrankingsdailyrequest.mdx index 1c8a59473..04784a9f4 100644 --- a/docs/operations/getrankingsdailyrequest.mdx +++ b/docs/operations/getrankingsdailyrequest.mdx @@ -6,13 +6,13 @@ title: "GetRankingsDailyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `start_date` | *Optional[str]* | ➖ | 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 | -| `end_date` | *Optional[str]* | ➖ | 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` | [Optional[operations.Period]](../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` | [Optional[operations.Modality]](../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 | -| `context_bucket` | [Optional[operations.ContextBucket]](../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` | [Optional[operations.GetRankingsDailyCategory]](../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 | -| `language_type` | [Optional[operations.LanguageType]](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `start_date` | *Optional[str]* | :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 | +| `end_date` | *Optional[str]* | :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` | [Optional[operations.Period]](../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` | [Optional[operations.Modality]](../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 | +| `context_bucket` | [Optional[operations.ContextBucket]](../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` | [Optional[operations.GetRankingsDailyCategory]](../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 | +| `language_type` | [Optional[operations.LanguageType]](../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/operations/getscimgroupmappingglobals.mdx b/docs/operations/getscimgroupmappingglobals.mdx index 9c87bcd2e..6d93a7f25 100644 --- a/docs/operations/getscimgroupmappingglobals.mdx +++ b/docs/operations/getscimgroupmappingglobals.mdx @@ -6,6 +6,6 @@ title: "GetScimGroupMappingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getscimgroupmappingrequest.mdx b/docs/operations/getscimgroupmappingrequest.mdx index f10663e49..65e59b601 100644 --- a/docs/operations/getscimgroupmappingrequest.mdx +++ b/docs/operations/getscimgroupmappingrequest.mdx @@ -6,7 +6,7 @@ title: "GetScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `id` | *str* | ✅ | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/getscimsyncjobglobals.mdx b/docs/operations/getscimsyncjobglobals.mdx index 1b8957588..43e7a43da 100644 --- a/docs/operations/getscimsyncjobglobals.mdx +++ b/docs/operations/getscimsyncjobglobals.mdx @@ -6,6 +6,6 @@ title: "GetScimSyncJobGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getscimsyncjobrequest.mdx b/docs/operations/getscimsyncjobrequest.mdx index 8ec38144b..6cf043dac 100644 --- a/docs/operations/getscimsyncjobrequest.mdx +++ b/docs/operations/getscimsyncjobrequest.mdx @@ -6,7 +6,7 @@ title: "GetScimSyncJobRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `id` | *str* | ✅ | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/getsessioncostglobals.mdx b/docs/operations/getsessioncostglobals.mdx index 6153e44e5..8ec32402d 100644 --- a/docs/operations/getsessioncostglobals.mdx +++ b/docs/operations/getsessioncostglobals.mdx @@ -6,6 +6,6 @@ title: "GetSessionCostGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getsessioncostrequest.mdx b/docs/operations/getsessioncostrequest.mdx index d7f6352ba..41b333db8 100644 --- a/docs/operations/getsessioncostrequest.mdx +++ b/docs/operations/getsessioncostrequest.mdx @@ -6,11 +6,11 @@ title: "GetSessionCostRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `app_slug` | *Optional[str]* | ➖ | Filter to one published harness slug. | hermes-agent | -| `model` | *Optional[str]* | ➖ | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | -| `turn_range` | [Optional[operations.TurnRange]](../operations/turnrange.mdx) | ➖ | Filter by the inclusive number of turns in a session. | 10-49-turns | -| `limit` | *Optional[int]* | ➖ | Maximum number of cells to return (1-500). Defaults to 100. | 100 | -| `offset` | *OptionalNullable[int]* | ➖ | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `app_slug` | *Optional[str]* | :heavy_minus_sign: | Filter to one published harness slug. | hermes-agent | +| `model` | *Optional[str]* | :heavy_minus_sign: | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | +| `turn_range` | [Optional[operations.TurnRange]](../operations/turnrange.mdx) | :heavy_minus_sign: | Filter by the inclusive number of turns in a session. | 10-49-turns | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of cells to return (1-500). Defaults to 100. | 100 | +| `offset` | *OptionalNullable[int]* | :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/operations/getsessioncostresponse.mdx b/docs/operations/getsessioncostresponse.mdx index c3d9e97c1..d79786dc8 100644 --- a/docs/operations/getsessioncostresponse.mdx +++ b/docs/operations/getsessioncostresponse.mdx @@ -6,4 +6,4 @@ title: "GetSessionCostResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `result` | [components.SessionCostResponse](../components/sessioncostresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `result` | [components.SessionCostResponse](../components/sessioncostresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/gettaskclassificationsglobals.mdx b/docs/operations/gettaskclassificationsglobals.mdx index 9753c9912..34e94c3bb 100644 --- a/docs/operations/gettaskclassificationsglobals.mdx +++ b/docs/operations/gettaskclassificationsglobals.mdx @@ -6,6 +6,6 @@ title: "GetTaskClassificationsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/gettaskclassificationsrequest.mdx b/docs/operations/gettaskclassificationsrequest.mdx index a2c427446..acb6b4834 100644 --- a/docs/operations/gettaskclassificationsrequest.mdx +++ b/docs/operations/gettaskclassificationsrequest.mdx @@ -6,7 +6,7 @@ title: "GetTaskClassificationsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `window` | [Optional[operations.Window]](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `window` | [Optional[operations.Window]](../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/operations/gettoolglobals.mdx b/docs/operations/gettoolglobals.mdx index aa3278d9e..2babeb71b 100644 --- a/docs/operations/gettoolglobals.mdx +++ b/docs/operations/gettoolglobals.mdx @@ -6,6 +6,6 @@ title: "GetToolGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/gettoolrequest.mdx b/docs/operations/gettoolrequest.mdx index 7d17a78e1..0d357688a 100644 --- a/docs/operations/gettoolrequest.mdx +++ b/docs/operations/gettoolrequest.mdx @@ -6,7 +6,7 @@ title: "GetToolRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `name` | *str* | ✅ | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `name` | *str* | :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/operations/gettoolresponse.mdx b/docs/operations/gettoolresponse.mdx index 090b2b7ff..ebca60fe7 100644 --- a/docs/operations/gettoolresponse.mdx +++ b/docs/operations/gettoolresponse.mdx @@ -6,5 +6,5 @@ title: "GetToolResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `headers` | Dict[str, List[*str*]] | ✅ | N/A | -| `result` | [Optional[components.GetToolResponse]](../components/gettoolresponse.mdx) | ➖ | N/A | \ No newline at end of file +| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | +| `result` | [Optional[components.GetToolResponse]](../components/gettoolresponse.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/operations/gettoolsecurity.mdx b/docs/operations/gettoolsecurity.mdx index 1bb9a8375..84b78828d 100644 --- a/docs/operations/gettoolsecurity.mdx +++ b/docs/operations/gettoolsecurity.mdx @@ -6,4 +6,4 @@ title: "GetToolSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *str* | ✅ | N/A | \ No newline at end of file +| `bearer` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/getuseractivityglobals.mdx b/docs/operations/getuseractivityglobals.mdx index a92f5e3bb..f31e13179 100644 --- a/docs/operations/getuseractivityglobals.mdx +++ b/docs/operations/getuseractivityglobals.mdx @@ -6,6 +6,6 @@ title: "GetUserActivityGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getuseractivityrequest.mdx b/docs/operations/getuseractivityrequest.mdx index 21c7a35f5..421ac1a9f 100644 --- a/docs/operations/getuseractivityrequest.mdx +++ b/docs/operations/getuseractivityrequest.mdx @@ -6,11 +6,11 @@ title: "GetUserActivityRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `date_` | *Optional[str]* | ➖ | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `api_key_hash` | *Optional[str]* | ➖ | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `user_id` | *Optional[str]* | ➖ | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | -| `group_by` | [Optional[operations.GroupBy]](../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 | -| `workspace_id` | *Optional[str]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `date_` | *Optional[str]* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | +| `api_key_hash` | *Optional[str]* | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | +| `user_id` | *Optional[str]* | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | +| `group_by` | [Optional[operations.GroupBy]](../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 | +| `workspace_id` | *Optional[str]* | :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/operations/getvideosglobals.mdx b/docs/operations/getvideosglobals.mdx index 3b525becf..7dfb46281 100644 --- a/docs/operations/getvideosglobals.mdx +++ b/docs/operations/getvideosglobals.mdx @@ -6,6 +6,6 @@ title: "GetVideosGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getvideosrequest.mdx b/docs/operations/getvideosrequest.mdx index 8c7dcd651..1b1c08753 100644 --- a/docs/operations/getvideosrequest.mdx +++ b/docs/operations/getvideosrequest.mdx @@ -6,7 +6,7 @@ title: "GetVideosRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `job_id` | *str* | ✅ | N/A | job-abc123 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | \ No newline at end of file diff --git a/docs/operations/getworkspacebudgetglobals.mdx b/docs/operations/getworkspacebudgetglobals.mdx index e7fe36c8d..9aa76f556 100644 --- a/docs/operations/getworkspacebudgetglobals.mdx +++ b/docs/operations/getworkspacebudgetglobals.mdx @@ -6,6 +6,6 @@ title: "GetWorkspaceBudgetGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getworkspacebudgetrequest.mdx b/docs/operations/getworkspacebudgetrequest.mdx index 483d59655..953412ee4 100644 --- a/docs/operations/getworkspacebudgetrequest.mdx +++ b/docs/operations/getworkspacebudgetrequest.mdx @@ -6,8 +6,8 @@ title: "GetWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../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/operations/getworkspaceglobals.mdx b/docs/operations/getworkspaceglobals.mdx index c1cbeb71a..b3d863a26 100644 --- a/docs/operations/getworkspaceglobals.mdx +++ b/docs/operations/getworkspaceglobals.mdx @@ -6,6 +6,6 @@ title: "GetWorkspaceGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getworkspacerequest.mdx b/docs/operations/getworkspacerequest.mdx index 1c1991af5..b9ee3b720 100644 --- a/docs/operations/getworkspacerequest.mdx +++ b/docs/operations/getworkspacerequest.mdx @@ -6,7 +6,7 @@ title: "GetWorkspaceRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/operations/granularity.mdx b/docs/operations/granularity.mdx index 9f3659151..8aa00fc17 100644 --- a/docs/operations/granularity.mdx +++ b/docs/operations/granularity.mdx @@ -6,5 +6,5 @@ title: "Granularity" | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `display_label` | *str* | ✅ | Human-readable label | Day | -| `name` | [operations.GranularityName](../operations/granularityname.mdx) | ✅ | Granularity identifier | day | \ No newline at end of file +| `display_label` | *str* | :heavy_check_mark: | Human-readable label | Day | +| `name` | [operations.GranularityName](../operations/granularityname.mdx) | :heavy_check_mark: | Granularity identifier | day | \ No newline at end of file diff --git a/docs/operations/imageurl.mdx b/docs/operations/imageurl.mdx index 1f6cc546a..693064d97 100644 --- a/docs/operations/imageurl.mdx +++ b/docs/operations/imageurl.mdx @@ -6,4 +6,4 @@ title: "ImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | ✅ | N/A | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/input.mdx b/docs/operations/input.mdx index 5230c6b5a..deecee214 100644 --- a/docs/operations/input.mdx +++ b/docs/operations/input.mdx @@ -6,4 +6,4 @@ title: "Input" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `content` | List[[operations.Content](../operations/content.mdx)] | ✅ | N/A | \ No newline at end of file +| `content` | List[[operations.Content](../operations/content.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/invokeinternglobals.mdx b/docs/operations/invokeinternglobals.mdx index 473ed152a..fc2a01268 100644 --- a/docs/operations/invokeinternglobals.mdx +++ b/docs/operations/invokeinternglobals.mdx @@ -6,6 +6,6 @@ title: "InvokeInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/invokeinternrequest.mdx b/docs/operations/invokeinternrequest.mdx index 84ec62f00..999ed9735 100644 --- a/docs/operations/invokeinternrequest.mdx +++ b/docs/operations/invokeinternrequest.mdx @@ -6,8 +6,8 @@ title: "InvokeInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | The intern to run. | a11e0000-0000-4000-8000-000000000005 | -| `intern_invoke_request` | [components.InternInvokeRequest](../components/interninvokerequest.mdx) | ✅ | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | The intern to run. | a11e0000-0000-4000-8000-000000000005 | +| `intern_invoke_request` | [components.InternInvokeRequest](../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/operations/invokeinternresponse.mdx b/docs/operations/invokeinternresponse.mdx index 23145f5ef..bf7427ee3 100644 --- a/docs/operations/invokeinternresponse.mdx +++ b/docs/operations/invokeinternresponse.mdx @@ -6,5 +6,5 @@ title: "InvokeInternResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | ✅ | N/A | | -| `result` | [components.InternInvokeAcceptedResponse](../components/interninvokeacceptedresponse.mdx) | ✅ | N/A | \{
"session_id": "b51a0e21-368b-4780-a220-14655bf28c55",
"status": "started"
} | \ No newline at end of file +| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | | +| `result` | [components.InternInvokeAcceptedResponse](../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/operations/listbatchesglobals.mdx b/docs/operations/listbatchesglobals.mdx index 681a0d319..62c0e67f6 100644 --- a/docs/operations/listbatchesglobals.mdx +++ b/docs/operations/listbatchesglobals.mdx @@ -6,6 +6,6 @@ title: "ListBatchesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listbatchesrequest.mdx b/docs/operations/listbatchesrequest.mdx index e6fd9d3f3..fd00d5a79 100644 --- a/docs/operations/listbatchesrequest.mdx +++ b/docs/operations/listbatchesrequest.mdx @@ -6,11 +6,11 @@ title: "ListBatchesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Maximum number of batches to return, from 1 through 100. | 20 | -| `after` | *Optional[str]* | ➖ | Batch id from the previous page's `last_id`. | batch_7a4b02 | -| `status` | List[[components.BatchListStatus](../components/batchliststatus.mdx)] | ➖ | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | -| `created_after` | [Optional[components.BatchListTimestamp]](../components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | -| `created_before` | [Optional[components.BatchListTimestamp]](../components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of batches to return, from 1 through 100. | 20 | +| `after` | *Optional[str]* | :heavy_minus_sign: | Batch id from the previous page's `last_id`. | batch_7a4b02 | +| `status` | List[[components.BatchListStatus](../components/batchliststatus.mdx)] | :heavy_minus_sign: | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | +| `created_after` | [Optional[components.BatchListTimestamp]](../components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | +| `created_before` | [Optional[components.BatchListTimestamp]](../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/operations/listbatchesresponse.mdx b/docs/operations/listbatchesresponse.mdx index b6a1e09fe..9a218bcdf 100644 --- a/docs/operations/listbatchesresponse.mdx +++ b/docs/operations/listbatchesresponse.mdx @@ -6,4 +6,4 @@ title: "ListBatchesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `result` | [components.BatchListResponse](../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](../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/operations/listbyokkeysglobals.mdx b/docs/operations/listbyokkeysglobals.mdx index 9ff457764..67a37d54c 100644 --- a/docs/operations/listbyokkeysglobals.mdx +++ b/docs/operations/listbyokkeysglobals.mdx @@ -6,6 +6,6 @@ title: "ListBYOKKeysGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listbyokkeysrequest.mdx b/docs/operations/listbyokkeysrequest.mdx index 44bfefb74..f55e2c02b 100644 --- a/docs/operations/listbyokkeysrequest.mdx +++ b/docs/operations/listbyokkeysrequest.mdx @@ -6,10 +6,10 @@ title: "ListBYOKKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | ➖ | 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` | [Optional[operations.Provider]](../operations/provider.mdx) | ➖ | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | :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` | [Optional[operations.Provider]](../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/operations/listbyokkeysresponse.mdx b/docs/operations/listbyokkeysresponse.mdx index 8e33decfd..e1615dcba 100644 --- a/docs/operations/listbyokkeysresponse.mdx +++ b/docs/operations/listbyokkeysresponse.mdx @@ -6,4 +6,4 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [components.ListBYOKKeysResponse](../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](../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/operations/listcontainerfilesglobals.mdx b/docs/operations/listcontainerfilesglobals.mdx index eca6ca636..3bd312de0 100644 --- a/docs/operations/listcontainerfilesglobals.mdx +++ b/docs/operations/listcontainerfilesglobals.mdx @@ -6,6 +6,6 @@ title: "ListContainerFilesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listcontainerfilesrequest.mdx b/docs/operations/listcontainerfilesrequest.mdx index dbcde136c..90add74a5 100644 --- a/docs/operations/listcontainerfilesrequest.mdx +++ b/docs/operations/listcontainerfilesrequest.mdx @@ -6,9 +6,9 @@ title: "ListContainerFilesRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `container_id` | *str* | ✅ | 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` | *Optional[int]* | ➖ | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | -| `after` | *Optional[str]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `container_id` | *str* | :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` | *Optional[int]* | :heavy_minus_sign: | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | +| `after` | *Optional[str]* | :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/operations/listdata.mdx b/docs/operations/listdata.mdx index 7de2f4b11..a68b8ca9b 100644 --- a/docs/operations/listdata.mdx +++ b/docs/operations/listdata.mdx @@ -6,26 +6,26 @@ title: "ListData" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | ✅ | 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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `external_user` | *Nullable[str]* | ✅ | Partner's end-user identifier used for attribution. | null | -| `hash` | *str* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | -| `name` | *str* | ✅ | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creator_user_id` | *Nullable[str]* | :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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `external_user` | *Nullable[str]* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | +| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | +| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *str* | :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/operations/listembeddingsmodelsglobals.mdx b/docs/operations/listembeddingsmodelsglobals.mdx index 0e12ec2e1..fad77722b 100644 --- a/docs/operations/listembeddingsmodelsglobals.mdx +++ b/docs/operations/listembeddingsmodelsglobals.mdx @@ -6,6 +6,6 @@ title: "ListEmbeddingsModelsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listembeddingsmodelsrequest.mdx b/docs/operations/listembeddingsmodelsrequest.mdx index dd273ae5c..ad3e91f1e 100644 --- a/docs/operations/listembeddingsmodelsrequest.mdx +++ b/docs/operations/listembeddingsmodelsrequest.mdx @@ -6,8 +6,8 @@ title: "ListEmbeddingsModelsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | :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/operations/listembeddingsmodelsresponse.mdx b/docs/operations/listembeddingsmodelsresponse.mdx index 207a7c495..053af0a81 100644 --- a/docs/operations/listembeddingsmodelsresponse.mdx +++ b/docs/operations/listembeddingsmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "ListEmbeddingsModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ModelsListResponse](../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](../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/operations/listendpointsglobals.mdx b/docs/operations/listendpointsglobals.mdx index d77c2f513..3e37c978a 100644 --- a/docs/operations/listendpointsglobals.mdx +++ b/docs/operations/listendpointsglobals.mdx @@ -6,6 +6,6 @@ title: "ListEndpointsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listendpointsrequest.mdx b/docs/operations/listendpointsrequest.mdx index 3fa36648c..ae60c3675 100644 --- a/docs/operations/listendpointsrequest.mdx +++ b/docs/operations/listendpointsrequest.mdx @@ -6,8 +6,8 @@ title: "ListEndpointsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *str* | ✅ | The author/organization of the model | openai | -| `slug` | *str* | ✅ | The model slug | gpt-4 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | +| `slug` | *str* | :heavy_check_mark: | The model slug | gpt-4 | \ No newline at end of file diff --git a/docs/operations/listendpointsresponse.mdx b/docs/operations/listendpointsresponse.mdx index edebc0fe6..f5f6478ea 100644 --- a/docs/operations/listendpointsresponse.mdx +++ b/docs/operations/listendpointsresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.ListEndpointsResponse](../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](../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/operations/listendpointszdrglobals.mdx b/docs/operations/listendpointszdrglobals.mdx index 794d7ca0d..8f47131ce 100644 --- a/docs/operations/listendpointszdrglobals.mdx +++ b/docs/operations/listendpointszdrglobals.mdx @@ -6,6 +6,6 @@ title: "ListEndpointsZdrGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listendpointszdrrequest.mdx b/docs/operations/listendpointszdrrequest.mdx index 6f5e7d90f..70f27d808 100644 --- a/docs/operations/listendpointszdrrequest.mdx +++ b/docs/operations/listendpointszdrrequest.mdx @@ -6,6 +6,6 @@ title: "ListEndpointsZdrRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listendpointszdrresponse.mdx b/docs/operations/listendpointszdrresponse.mdx index 79b2f2af3..31012e2cf 100644 --- a/docs/operations/listendpointszdrresponse.mdx +++ b/docs/operations/listendpointszdrresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `data` | List[[components.PublicEndpoint](../components/publicendpoint.mdx)] | ✅ | N/A | \ No newline at end of file +| `data` | List[[components.PublicEndpoint](../components/publicendpoint.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/listendusersglobals.mdx b/docs/operations/listendusersglobals.mdx index e4ece3f6e..3b3fecc1e 100644 --- a/docs/operations/listendusersglobals.mdx +++ b/docs/operations/listendusersglobals.mdx @@ -6,6 +6,6 @@ title: "ListEndUsersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listendusersrequest.mdx b/docs/operations/listendusersrequest.mdx index 838bc726f..a115cdba4 100644 --- a/docs/operations/listendusersrequest.mdx +++ b/docs/operations/listendusersrequest.mdx @@ -6,10 +6,10 @@ title: "ListEndUsersRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `user` | *Optional[str]* | ➖ | 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 | -| `include_inactive` | *Optional[bool]* | ➖ | Include deactivated registrations. | false | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `user` | *Optional[str]* | :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 | +| `include_inactive` | *Optional[bool]* | :heavy_minus_sign: | Include deactivated registrations. | false | \ No newline at end of file diff --git a/docs/operations/listendusersresponse.mdx b/docs/operations/listendusersresponse.mdx index e110c2df2..d8ac52622 100644 --- a/docs/operations/listendusersresponse.mdx +++ b/docs/operations/listendusersresponse.mdx @@ -6,4 +6,4 @@ title: "ListEndUsersResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListEndUsersResponse](../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](../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/operations/listfilesglobals.mdx b/docs/operations/listfilesglobals.mdx index 199c293db..5e86176bf 100644 --- a/docs/operations/listfilesglobals.mdx +++ b/docs/operations/listfilesglobals.mdx @@ -6,6 +6,6 @@ title: "ListFilesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listfilesrequest.mdx b/docs/operations/listfilesrequest.mdx index bca3e7ac5..df4338da0 100644 --- a/docs/operations/listfilesrequest.mdx +++ b/docs/operations/listfilesrequest.mdx @@ -6,14 +6,14 @@ title: "ListFilesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Maximum number of files to return (1–1000). | 100 | -| `cursor` | *Optional[str]* | ➖ | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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` | *Optional[str]* | ➖ | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `after_id` | *Optional[str]* | ➖ | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `before_id` | *Optional[str]* | ➖ | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `order` | [Optional[operations.Order]](../operations/order.mdx) | ➖ | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of files to return (1–1000). | 100 | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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` | *Optional[str]* | :heavy_minus_sign: | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `after_id` | *Optional[str]* | :heavy_minus_sign: | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `before_id` | *Optional[str]* | :heavy_minus_sign: | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `order` | [Optional[operations.Order]](../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/operations/listfilesresponse.mdx b/docs/operations/listfilesresponse.mdx index 5522ebc07..bc29d45a6 100644 --- a/docs/operations/listfilesresponse.mdx +++ b/docs/operations/listfilesresponse.mdx @@ -6,4 +6,4 @@ title: "ListFilesResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `result` | [components.FileListResponse](../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](../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/operations/listgenerationcontentglobals.mdx b/docs/operations/listgenerationcontentglobals.mdx index b3d82e6fc..8096c174f 100644 --- a/docs/operations/listgenerationcontentglobals.mdx +++ b/docs/operations/listgenerationcontentglobals.mdx @@ -6,6 +6,6 @@ title: "ListGenerationContentGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listgenerationcontentrequest.mdx b/docs/operations/listgenerationcontentrequest.mdx index 89bbcf386..d1caecbb5 100644 --- a/docs/operations/listgenerationcontentrequest.mdx +++ b/docs/operations/listgenerationcontentrequest.mdx @@ -6,7 +6,7 @@ title: "ListGenerationContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/operations/listglobals.mdx b/docs/operations/listglobals.mdx index 6774b3ef5..b13c7abde 100644 --- a/docs/operations/listglobals.mdx +++ b/docs/operations/listglobals.mdx @@ -6,6 +6,6 @@ title: "ListGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listguardrailkeyassignmentsglobals.mdx b/docs/operations/listguardrailkeyassignmentsglobals.mdx index 4f6598763..8b06bf79e 100644 --- a/docs/operations/listguardrailkeyassignmentsglobals.mdx +++ b/docs/operations/listguardrailkeyassignmentsglobals.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailKeyAssignmentsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listguardrailkeyassignmentsrequest.mdx b/docs/operations/listguardrailkeyassignmentsrequest.mdx index 953169080..0197e6a85 100644 --- a/docs/operations/listguardrailkeyassignmentsrequest.mdx +++ b/docs/operations/listguardrailkeyassignmentsrequest.mdx @@ -6,9 +6,9 @@ title: "ListGuardrailKeyAssignmentsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listguardrailkeyassignmentsresponse.mdx b/docs/operations/listguardrailkeyassignmentsresponse.mdx index a1d8fb3fe..868475866 100644 --- a/docs/operations/listguardrailkeyassignmentsresponse.mdx +++ b/docs/operations/listguardrailkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListKeyAssignmentsResponse](../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](../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/operations/listguardrailmemberassignmentsglobals.mdx b/docs/operations/listguardrailmemberassignmentsglobals.mdx index ecb52ea72..98c69e74c 100644 --- a/docs/operations/listguardrailmemberassignmentsglobals.mdx +++ b/docs/operations/listguardrailmemberassignmentsglobals.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailMemberAssignmentsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listguardrailmemberassignmentsrequest.mdx b/docs/operations/listguardrailmemberassignmentsrequest.mdx index c41856dcc..c7d2bdab2 100644 --- a/docs/operations/listguardrailmemberassignmentsrequest.mdx +++ b/docs/operations/listguardrailmemberassignmentsrequest.mdx @@ -6,9 +6,9 @@ title: "ListGuardrailMemberAssignmentsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listguardrailmemberassignmentsresponse.mdx b/docs/operations/listguardrailmemberassignmentsresponse.mdx index 14426922f..3c19a6f18 100644 --- a/docs/operations/listguardrailmemberassignmentsresponse.mdx +++ b/docs/operations/listguardrailmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListMemberAssignmentsResponse](../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](../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/operations/listguardrailsglobals.mdx b/docs/operations/listguardrailsglobals.mdx index 48b141f20..60d11dfac 100644 --- a/docs/operations/listguardrailsglobals.mdx +++ b/docs/operations/listguardrailsglobals.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listguardrailsrequest.mdx b/docs/operations/listguardrailsrequest.mdx index c84b9a13d..465dde596 100644 --- a/docs/operations/listguardrailsrequest.mdx +++ b/docs/operations/listguardrailsrequest.mdx @@ -6,9 +6,9 @@ title: "ListGuardrailsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | :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/operations/listguardrailsresponse.mdx b/docs/operations/listguardrailsresponse.mdx index 7ac925b1d..e3b731505 100644 --- a/docs/operations/listguardrailsresponse.mdx +++ b/docs/operations/listguardrailsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListGuardrailsResponse](../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](../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/operations/listimagemodelendpointsglobals.mdx b/docs/operations/listimagemodelendpointsglobals.mdx index 2aadf9a73..ffac4de97 100644 --- a/docs/operations/listimagemodelendpointsglobals.mdx +++ b/docs/operations/listimagemodelendpointsglobals.mdx @@ -6,6 +6,6 @@ title: "ListImageModelEndpointsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listimagemodelendpointsrequest.mdx b/docs/operations/listimagemodelendpointsrequest.mdx index 9fe96e1a5..871687a00 100644 --- a/docs/operations/listimagemodelendpointsrequest.mdx +++ b/docs/operations/listimagemodelendpointsrequest.mdx @@ -6,8 +6,8 @@ title: "ListImageModelEndpointsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *str* | ✅ | Model author/organization | bytedance-seed | -| `slug` | *str* | ✅ | Model slug | seedream-4.5 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `author` | *str* | :heavy_check_mark: | Model author/organization | bytedance-seed | +| `slug` | *str* | :heavy_check_mark: | Model slug | seedream-4.5 | \ No newline at end of file diff --git a/docs/operations/listimagemodelsglobals.mdx b/docs/operations/listimagemodelsglobals.mdx index 5a2958a49..e3ad1251b 100644 --- a/docs/operations/listimagemodelsglobals.mdx +++ b/docs/operations/listimagemodelsglobals.mdx @@ -6,6 +6,6 @@ title: "ListImageModelsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listimagemodelsrequest.mdx b/docs/operations/listimagemodelsrequest.mdx index 1c45ba409..590e46d83 100644 --- a/docs/operations/listimagemodelsrequest.mdx +++ b/docs/operations/listimagemodelsrequest.mdx @@ -6,6 +6,6 @@ title: "ListImageModelsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listinterneffectivevaultsecretsglobals.mdx b/docs/operations/listinterneffectivevaultsecretsglobals.mdx index de0a0db8e..bd5c8c464 100644 --- a/docs/operations/listinterneffectivevaultsecretsglobals.mdx +++ b/docs/operations/listinterneffectivevaultsecretsglobals.mdx @@ -6,6 +6,6 @@ title: "ListInternEffectiveVaultSecretsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listinterneffectivevaultsecretsrequest.mdx b/docs/operations/listinterneffectivevaultsecretsrequest.mdx index 900dcf3e2..ca1e31d1c 100644 --- a/docs/operations/listinterneffectivevaultsecretsrequest.mdx +++ b/docs/operations/listinterneffectivevaultsecretsrequest.mdx @@ -6,9 +6,9 @@ title: "ListInternEffectiveVaultSecretsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | :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/operations/listinternsglobals.mdx b/docs/operations/listinternsglobals.mdx index 94241de64..3a55ed59f 100644 --- a/docs/operations/listinternsglobals.mdx +++ b/docs/operations/listinternsglobals.mdx @@ -6,6 +6,6 @@ title: "ListInternsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listinternsrequest.mdx b/docs/operations/listinternsrequest.mdx index 30f908550..c595b861d 100644 --- a/docs/operations/listinternsrequest.mdx +++ b/docs/operations/listinternsrequest.mdx @@ -6,10 +6,10 @@ title: "ListInternsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Maximum number of interns to return, from 1 through 500. | 50 | -| `status` | List[[operations.Status](../operations/status.mdx)] | ➖ | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | -| `starting_after` | *Optional[str]* | ➖ | 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 | -| `workspace_id` | *Optional[str]* | ➖ | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of interns to return, from 1 through 500. | 50 | +| `status` | List[[operations.Status](../operations/status.mdx)] | :heavy_minus_sign: | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | +| `starting_after` | *Optional[str]* | :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 | +| `workspace_id` | *Optional[str]* | :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/operations/listinternvaultsecretsglobals.mdx b/docs/operations/listinternvaultsecretsglobals.mdx index 97687a0b3..032e98ae1 100644 --- a/docs/operations/listinternvaultsecretsglobals.mdx +++ b/docs/operations/listinternvaultsecretsglobals.mdx @@ -6,6 +6,6 @@ title: "ListInternVaultSecretsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listinternvaultsecretsrequest.mdx b/docs/operations/listinternvaultsecretsrequest.mdx index 59190cfb2..feadc7485 100644 --- a/docs/operations/listinternvaultsecretsrequest.mdx +++ b/docs/operations/listinternvaultsecretsrequest.mdx @@ -6,9 +6,9 @@ title: "ListInternVaultSecretsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | :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/operations/listkeyassignmentsglobals.mdx b/docs/operations/listkeyassignmentsglobals.mdx index e497a4ed0..a93efaec3 100644 --- a/docs/operations/listkeyassignmentsglobals.mdx +++ b/docs/operations/listkeyassignmentsglobals.mdx @@ -6,6 +6,6 @@ title: "ListKeyAssignmentsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listkeyassignmentsrequest.mdx b/docs/operations/listkeyassignmentsrequest.mdx index 31080be44..9ca686875 100644 --- a/docs/operations/listkeyassignmentsrequest.mdx +++ b/docs/operations/listkeyassignmentsrequest.mdx @@ -6,8 +6,8 @@ title: "ListKeyAssignmentsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listkeyassignmentsresponse.mdx b/docs/operations/listkeyassignmentsresponse.mdx index 05e61ef7e..b26f687df 100644 --- a/docs/operations/listkeyassignmentsresponse.mdx +++ b/docs/operations/listkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListKeyAssignmentsResponse](../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](../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/operations/listmemberassignmentsglobals.mdx b/docs/operations/listmemberassignmentsglobals.mdx index 93d863c44..e5d123af9 100644 --- a/docs/operations/listmemberassignmentsglobals.mdx +++ b/docs/operations/listmemberassignmentsglobals.mdx @@ -6,6 +6,6 @@ title: "ListMemberAssignmentsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listmemberassignmentsrequest.mdx b/docs/operations/listmemberassignmentsrequest.mdx index e0c6b6afb..7215640ea 100644 --- a/docs/operations/listmemberassignmentsrequest.mdx +++ b/docs/operations/listmemberassignmentsrequest.mdx @@ -6,8 +6,8 @@ title: "ListMemberAssignmentsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listmemberassignmentsresponse.mdx b/docs/operations/listmemberassignmentsresponse.mdx index 92cc8f0c9..0206ec09d 100644 --- a/docs/operations/listmemberassignmentsresponse.mdx +++ b/docs/operations/listmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListMemberAssignmentsResponse](../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](../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/operations/listmodelscountglobals.mdx b/docs/operations/listmodelscountglobals.mdx index c33a388a2..0daab751f 100644 --- a/docs/operations/listmodelscountglobals.mdx +++ b/docs/operations/listmodelscountglobals.mdx @@ -6,6 +6,6 @@ title: "ListModelsCountGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listmodelscountrequest.mdx b/docs/operations/listmodelscountrequest.mdx index 7e3909022..163aa28dd 100644 --- a/docs/operations/listmodelscountrequest.mdx +++ b/docs/operations/listmodelscountrequest.mdx @@ -6,7 +6,7 @@ title: "ListModelsCountRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `output_modalities` | *Optional[str]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `output_modalities` | *Optional[str]* | :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/operations/listmodelsuserglobals.mdx b/docs/operations/listmodelsuserglobals.mdx index b6ff4ac61..f0a800135 100644 --- a/docs/operations/listmodelsuserglobals.mdx +++ b/docs/operations/listmodelsuserglobals.mdx @@ -6,6 +6,6 @@ title: "ListModelsUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listmodelsuserrequest.mdx b/docs/operations/listmodelsuserrequest.mdx index 61a97beb1..0ad201f8a 100644 --- a/docs/operations/listmodelsuserrequest.mdx +++ b/docs/operations/listmodelsuserrequest.mdx @@ -6,9 +6,9 @@ title: "ListModelsUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `output_modalities` | *Optional[str]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `output_modalities` | *Optional[str]* | :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/operations/listmodelsuserresponse.mdx b/docs/operations/listmodelsuserresponse.mdx index 0ed4eca01..380f686c1 100644 --- a/docs/operations/listmodelsuserresponse.mdx +++ b/docs/operations/listmodelsuserresponse.mdx @@ -6,4 +6,4 @@ title: "ListModelsUserResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ModelsListResponse](../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](../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/operations/listmodelsusersecurity.mdx b/docs/operations/listmodelsusersecurity.mdx index b5f5a5361..c7dbff35b 100644 --- a/docs/operations/listmodelsusersecurity.mdx +++ b/docs/operations/listmodelsusersecurity.mdx @@ -6,4 +6,4 @@ title: "ListModelsUserSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *str* | ✅ | N/A | \ No newline at end of file +| `bearer` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/listoauthjwksglobals.mdx b/docs/operations/listoauthjwksglobals.mdx index d55e03c85..17a2b2df2 100644 --- a/docs/operations/listoauthjwksglobals.mdx +++ b/docs/operations/listoauthjwksglobals.mdx @@ -6,6 +6,6 @@ title: "ListOauthJwksGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listoauthjwksrequest.mdx b/docs/operations/listoauthjwksrequest.mdx index aa79b539f..b0535221a 100644 --- a/docs/operations/listoauthjwksrequest.mdx +++ b/docs/operations/listoauthjwksrequest.mdx @@ -6,6 +6,6 @@ title: "ListOauthJwksRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listobservabilitydestinationsglobals.mdx b/docs/operations/listobservabilitydestinationsglobals.mdx index 17f003ef8..40271fec1 100644 --- a/docs/operations/listobservabilitydestinationsglobals.mdx +++ b/docs/operations/listobservabilitydestinationsglobals.mdx @@ -6,6 +6,6 @@ title: "ListObservabilityDestinationsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listobservabilitydestinationsrequest.mdx b/docs/operations/listobservabilitydestinationsrequest.mdx index c1922a71e..939ce50af 100644 --- a/docs/operations/listobservabilitydestinationsrequest.mdx +++ b/docs/operations/listobservabilitydestinationsrequest.mdx @@ -6,9 +6,9 @@ title: "ListObservabilityDestinationsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | :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/operations/listobservabilitydestinationsresponse.mdx b/docs/operations/listobservabilitydestinationsresponse.mdx index a0631b095..2c5e760b9 100644 --- a/docs/operations/listobservabilitydestinationsresponse.mdx +++ b/docs/operations/listobservabilitydestinationsresponse.mdx @@ -6,4 +6,4 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListObservabilityDestinationsResponse](../components/listobservabilitydestinationsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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](../components/listobservabilitydestinationsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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/operations/listorganizationmembersdata.mdx b/docs/operations/listorganizationmembersdata.mdx index 5879c38a6..2469c6aef 100644 --- a/docs/operations/listorganizationmembersdata.mdx +++ b/docs/operations/listorganizationmembersdata.mdx @@ -6,8 +6,8 @@ title: "ListOrganizationMembersData" | Field | Type | Required | Description | Example | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `email` | *str* | ✅ | Email address of the member | jane.doe@example.com | -| `first_name` | *Nullable[str]* | ✅ | First name of the member | Jane | -| `id` | *str* | ✅ | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | -| `last_name` | *Nullable[str]* | ✅ | Last name of the member | Doe | -| `role` | [operations.Role](../operations/role.mdx) | ✅ | Role of the member in the organization | org:member | \ No newline at end of file +| `email` | *str* | :heavy_check_mark: | Email address of the member | jane.doe@example.com | +| `first_name` | *Nullable[str]* | :heavy_check_mark: | First name of the member | Jane | +| `id` | *str* | :heavy_check_mark: | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | +| `last_name` | *Nullable[str]* | :heavy_check_mark: | Last name of the member | Doe | +| `role` | [operations.Role](../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/operations/listorganizationmembersglobals.mdx b/docs/operations/listorganizationmembersglobals.mdx index 5a74849d8..de31dc7f5 100644 --- a/docs/operations/listorganizationmembersglobals.mdx +++ b/docs/operations/listorganizationmembersglobals.mdx @@ -6,6 +6,6 @@ title: "ListOrganizationMembersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listorganizationmembersrequest.mdx b/docs/operations/listorganizationmembersrequest.mdx index 6e57d5edc..b9c2c5a33 100644 --- a/docs/operations/listorganizationmembersrequest.mdx +++ b/docs/operations/listorganizationmembersrequest.mdx @@ -6,8 +6,8 @@ title: "ListOrganizationMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listorganizationmembersresponse.mdx b/docs/operations/listorganizationmembersresponse.mdx index 73391339b..5de552097 100644 --- a/docs/operations/listorganizationmembersresponse.mdx +++ b/docs/operations/listorganizationmembersresponse.mdx @@ -6,4 +6,4 @@ title: "ListOrganizationMembersResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `result` | [operations.ListOrganizationMembersResponseBody](../operations/listorganizationmembersresponsebody.mdx) | ✅ | N/A | \ No newline at end of file +| `result` | [operations.ListOrganizationMembersResponseBody](../operations/listorganizationmembersresponsebody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/listorganizationmembersresponsebody.mdx b/docs/operations/listorganizationmembersresponsebody.mdx index 9b9946404..56cd9c557 100644 --- a/docs/operations/listorganizationmembersresponsebody.mdx +++ b/docs/operations/listorganizationmembersresponsebody.mdx @@ -9,5 +9,5 @@ List of organization members | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `data` | List[[operations.ListOrganizationMembersData](../operations/listorganizationmembersdata.mdx)] | ✅ | List of organization members | | -| `total_count` | *int* | ✅ | Total number of members in the organization | 25 | \ No newline at end of file +| `data` | List[[operations.ListOrganizationMembersData](../operations/listorganizationmembersdata.mdx)] | :heavy_check_mark: | List of organization members | | +| `total_count` | *int* | :heavy_check_mark: | Total number of members in the organization | 25 | \ No newline at end of file diff --git a/docs/operations/listpresetsglobals.mdx b/docs/operations/listpresetsglobals.mdx index a0d0bd85d..73d98355a 100644 --- a/docs/operations/listpresetsglobals.mdx +++ b/docs/operations/listpresetsglobals.mdx @@ -6,6 +6,6 @@ title: "ListPresetsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listpresetsrequest.mdx b/docs/operations/listpresetsrequest.mdx index 947e5e16a..d3f380a31 100644 --- a/docs/operations/listpresetsrequest.mdx +++ b/docs/operations/listpresetsrequest.mdx @@ -6,8 +6,8 @@ title: "ListPresetsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listpresetsresponse.mdx b/docs/operations/listpresetsresponse.mdx index afaac85ea..0bd7386a5 100644 --- a/docs/operations/listpresetsresponse.mdx +++ b/docs/operations/listpresetsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [components.ListPresetsResponse](../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](../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/operations/listpresetversionsglobals.mdx b/docs/operations/listpresetversionsglobals.mdx index f043e963b..f97938ef0 100644 --- a/docs/operations/listpresetversionsglobals.mdx +++ b/docs/operations/listpresetversionsglobals.mdx @@ -6,6 +6,6 @@ title: "ListPresetVersionsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listpresetversionsrequest.mdx b/docs/operations/listpresetversionsrequest.mdx index 2ffe5ebd5..f33507722 100644 --- a/docs/operations/listpresetversionsrequest.mdx +++ b/docs/operations/listpresetversionsrequest.mdx @@ -6,9 +6,9 @@ title: "ListPresetVersionsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listpresetversionsresponse.mdx b/docs/operations/listpresetversionsresponse.mdx index e6f1f7d64..794d77eb2 100644 --- a/docs/operations/listpresetversionsresponse.mdx +++ b/docs/operations/listpresetversionsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetVersionsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [components.ListPresetVersionsResponse](../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](../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/operations/listprivateendpointsglobals.mdx b/docs/operations/listprivateendpointsglobals.mdx index 6e53d08e6..6306718f7 100644 --- a/docs/operations/listprivateendpointsglobals.mdx +++ b/docs/operations/listprivateendpointsglobals.mdx @@ -6,6 +6,6 @@ title: "ListPrivateEndpointsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listprivateendpointsrequest.mdx b/docs/operations/listprivateendpointsrequest.mdx index cd5702265..bc225950e 100644 --- a/docs/operations/listprivateendpointsrequest.mdx +++ b/docs/operations/listprivateendpointsrequest.mdx @@ -6,6 +6,6 @@ title: "ListPrivateEndpointsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listprovidersdata.mdx b/docs/operations/listprovidersdata.mdx index 974c7918b..10580e98d 100644 --- a/docs/operations/listprovidersdata.mdx +++ b/docs/operations/listprovidersdata.mdx @@ -6,10 +6,10 @@ title: "ListProvidersData" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `datacenters` | List[[operations.Datacenter](../operations/datacenter.mdx)] | ➖ | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `headquarters` | [OptionalNullable[operations.Headquarters]](../operations/headquarters.mdx) | ➖ | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | -| `name` | *str* | ✅ | Display name of the provider | OpenAI | -| `privacy_policy_url` | *Nullable[str]* | ✅ | URL to the provider's privacy policy | https://openai.com/privacy | -| `slug` | *str* | ✅ | URL-friendly identifier for the provider | openai | -| `status_page_url` | *OptionalNullable[str]* | ➖ | URL to the provider's status page | https://status.openai.com | -| `terms_of_service_url` | *OptionalNullable[str]* | ➖ | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file +| `datacenters` | List[[operations.Datacenter](../operations/datacenter.mdx)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | +| `headquarters` | [OptionalNullable[operations.Headquarters]](../operations/headquarters.mdx) | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | +| `name` | *str* | :heavy_check_mark: | Display name of the provider | OpenAI | +| `privacy_policy_url` | *Nullable[str]* | :heavy_check_mark: | URL to the provider's privacy policy | https://openai.com/privacy | +| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the provider | openai | +| `status_page_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | +| `terms_of_service_url` | *OptionalNullable[str]* | :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/operations/listprovidersglobals.mdx b/docs/operations/listprovidersglobals.mdx index c4826aba3..2ad08ac05 100644 --- a/docs/operations/listprovidersglobals.mdx +++ b/docs/operations/listprovidersglobals.mdx @@ -6,6 +6,6 @@ title: "ListProvidersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listprovidersrequest.mdx b/docs/operations/listprovidersrequest.mdx index 34686a50e..5514d8141 100644 --- a/docs/operations/listprovidersrequest.mdx +++ b/docs/operations/listprovidersrequest.mdx @@ -6,6 +6,6 @@ title: "ListProvidersRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listprovidersresponse.mdx b/docs/operations/listprovidersresponse.mdx index 90ccff07b..81b20bf49 100644 --- a/docs/operations/listprovidersresponse.mdx +++ b/docs/operations/listprovidersresponse.mdx @@ -9,4 +9,4 @@ Returns a list of providers | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | List[[operations.ListProvidersData](../operations/listprovidersdata.mdx)] | ✅ | N/A | \ No newline at end of file +| `data` | List[[operations.ListProvidersData](../operations/listprovidersdata.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/listrequest.mdx b/docs/operations/listrequest.mdx index f8b721eb4..94a52d362 100644 --- a/docs/operations/listrequest.mdx +++ b/docs/operations/listrequest.mdx @@ -6,10 +6,10 @@ title: "ListRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `include_disabled` | *Optional[bool]* | ➖ | Whether to include disabled API keys in the response | false | -| `include_expired` | *Optional[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[int]* | ➖ | Number of API keys to skip for pagination | 0 | -| `workspace_id` | *Optional[str]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `include_disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | +| `include_expired` | *Optional[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[int]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | +| `workspace_id` | *Optional[str]* | :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/operations/listresponse.mdx b/docs/operations/listresponse.mdx index 0f6002eca..ffadcfc30 100644 --- a/docs/operations/listresponse.mdx +++ b/docs/operations/listresponse.mdx @@ -9,4 +9,4 @@ List of API keys | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | List[[operations.ListData](../operations/listdata.mdx)] | ✅ | List of API keys | \ No newline at end of file +| `data` | List[[operations.ListData](../operations/listdata.mdx)] | :heavy_check_mark: | List of API keys | \ No newline at end of file diff --git a/docs/operations/listscimgroupmappingsglobals.mdx b/docs/operations/listscimgroupmappingsglobals.mdx index ff722300c..579e2acea 100644 --- a/docs/operations/listscimgroupmappingsglobals.mdx +++ b/docs/operations/listscimgroupmappingsglobals.mdx @@ -6,6 +6,6 @@ title: "ListScimGroupMappingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listscimgroupmappingsrequest.mdx b/docs/operations/listscimgroupmappingsrequest.mdx index 62346a667..e30aea7a5 100644 --- a/docs/operations/listscimgroupmappingsrequest.mdx +++ b/docs/operations/listscimgroupmappingsrequest.mdx @@ -6,8 +6,8 @@ title: "ListScimGroupMappingsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listscimgroupmappingsresponse.mdx b/docs/operations/listscimgroupmappingsresponse.mdx index ababb58d5..f426e5f45 100644 --- a/docs/operations/listscimgroupmappingsresponse.mdx +++ b/docs/operations/listscimgroupmappingsresponse.mdx @@ -6,4 +6,4 @@ title: "ListScimGroupMappingsResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `result` | [components.ListScimGroupMappingsResponse](../components/listscimgroupmappingsresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `result` | [components.ListScimGroupMappingsResponse](../components/listscimgroupmappingsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/listscimgroupsglobals.mdx b/docs/operations/listscimgroupsglobals.mdx index 87e77c400..5294ada2e 100644 --- a/docs/operations/listscimgroupsglobals.mdx +++ b/docs/operations/listscimgroupsglobals.mdx @@ -6,6 +6,6 @@ title: "ListScimGroupsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listscimgroupsrequest.mdx b/docs/operations/listscimgroupsrequest.mdx index 7c1dd4612..d08e86e01 100644 --- a/docs/operations/listscimgroupsrequest.mdx +++ b/docs/operations/listscimgroupsrequest.mdx @@ -6,10 +6,10 @@ title: "ListScimGroupsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `display_name` | *Optional[str]* | ➖ | 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 | -| `external_id` | *Optional[str]* | ➖ | 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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `display_name` | *Optional[str]* | :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 | +| `external_id` | *Optional[str]* | :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/operations/listscimgroupsresponse.mdx b/docs/operations/listscimgroupsresponse.mdx index ccebbd181..80f9a41f5 100644 --- a/docs/operations/listscimgroupsresponse.mdx +++ b/docs/operations/listscimgroupsresponse.mdx @@ -6,4 +6,4 @@ title: "ListScimGroupsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `result` | [components.ListScimGroupsResponse](../components/listscimgroupsresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `result` | [components.ListScimGroupsResponse](../components/listscimgroupsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/listtoolsglobals.mdx b/docs/operations/listtoolsglobals.mdx index be81f3e6e..39d3d2c10 100644 --- a/docs/operations/listtoolsglobals.mdx +++ b/docs/operations/listtoolsglobals.mdx @@ -6,6 +6,6 @@ title: "ListToolsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listtoolsrequest.mdx b/docs/operations/listtoolsrequest.mdx index 7b36c4dfe..4a996545d 100644 --- a/docs/operations/listtoolsrequest.mdx +++ b/docs/operations/listtoolsrequest.mdx @@ -6,9 +6,9 @@ title: "ListToolsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | -| `api_format` | [Optional[operations.APIFormat]](../operations/apiformat.mdx) | ➖ | Only tools usable on this API format | responses | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | +| `api_format` | [Optional[operations.APIFormat]](../operations/apiformat.mdx) | :heavy_minus_sign: | Only tools usable on this API format | responses | \ No newline at end of file diff --git a/docs/operations/listtoolssecurity.mdx b/docs/operations/listtoolssecurity.mdx index 95e8eb5db..92fe7946e 100644 --- a/docs/operations/listtoolssecurity.mdx +++ b/docs/operations/listtoolssecurity.mdx @@ -6,4 +6,4 @@ title: "ListToolsSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *str* | ✅ | N/A | \ No newline at end of file +| `bearer` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/listvaultsecretsglobals.mdx b/docs/operations/listvaultsecretsglobals.mdx index cbe965813..0d090bdea 100644 --- a/docs/operations/listvaultsecretsglobals.mdx +++ b/docs/operations/listvaultsecretsglobals.mdx @@ -6,6 +6,6 @@ title: "ListVaultSecretsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listvaultsecretsrequest.mdx b/docs/operations/listvaultsecretsrequest.mdx index 18834a34d..962a3e12c 100644 --- a/docs/operations/listvaultsecretsrequest.mdx +++ b/docs/operations/listvaultsecretsrequest.mdx @@ -6,8 +6,8 @@ title: "ListVaultSecretsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | :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/operations/listvideoscontentglobals.mdx b/docs/operations/listvideoscontentglobals.mdx index a81b48e72..4a27d350e 100644 --- a/docs/operations/listvideoscontentglobals.mdx +++ b/docs/operations/listvideoscontentglobals.mdx @@ -6,6 +6,6 @@ title: "ListVideosContentGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listvideoscontentrequest.mdx b/docs/operations/listvideoscontentrequest.mdx index e54fe6a6f..0ecef072f 100644 --- a/docs/operations/listvideoscontentrequest.mdx +++ b/docs/operations/listvideoscontentrequest.mdx @@ -6,8 +6,8 @@ title: "ListVideosContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `job_id` | *str* | ✅ | N/A | job-abc123 | -| `index` | *OptionalNullable[int]* | ➖ | N/A | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | +| `index` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 0 | \ No newline at end of file diff --git a/docs/operations/listvideosmodelsglobals.mdx b/docs/operations/listvideosmodelsglobals.mdx index 8332329b5..a7fc9b7b2 100644 --- a/docs/operations/listvideosmodelsglobals.mdx +++ b/docs/operations/listvideosmodelsglobals.mdx @@ -6,6 +6,6 @@ title: "ListVideosModelsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listvideosmodelsrequest.mdx b/docs/operations/listvideosmodelsrequest.mdx index 37eed3047..5bd866fda 100644 --- a/docs/operations/listvideosmodelsrequest.mdx +++ b/docs/operations/listvideosmodelsrequest.mdx @@ -6,6 +6,6 @@ title: "ListVideosModelsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listworkspacebudgetsglobals.mdx b/docs/operations/listworkspacebudgetsglobals.mdx index 6a68defee..88549dbdc 100644 --- a/docs/operations/listworkspacebudgetsglobals.mdx +++ b/docs/operations/listworkspacebudgetsglobals.mdx @@ -6,6 +6,6 @@ title: "ListWorkspaceBudgetsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listworkspacebudgetsrequest.mdx b/docs/operations/listworkspacebudgetsrequest.mdx index 6a0912851..d076d36ce 100644 --- a/docs/operations/listworkspacebudgetsrequest.mdx +++ b/docs/operations/listworkspacebudgetsrequest.mdx @@ -6,7 +6,7 @@ title: "ListWorkspaceBudgetsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/operations/listworkspacemembersglobals.mdx b/docs/operations/listworkspacemembersglobals.mdx index 68652790b..c8f845c55 100644 --- a/docs/operations/listworkspacemembersglobals.mdx +++ b/docs/operations/listworkspacemembersglobals.mdx @@ -6,6 +6,6 @@ title: "ListWorkspaceMembersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listworkspacemembersrequest.mdx b/docs/operations/listworkspacemembersrequest.mdx index cff5df07f..0c97c81ea 100644 --- a/docs/operations/listworkspacemembersrequest.mdx +++ b/docs/operations/listworkspacemembersrequest.mdx @@ -6,9 +6,9 @@ title: "ListWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listworkspacemembersresponse.mdx b/docs/operations/listworkspacemembersresponse.mdx index f08af8246..94558019b 100644 --- a/docs/operations/listworkspacemembersresponse.mdx +++ b/docs/operations/listworkspacemembersresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListWorkspaceMembersResponse](../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](../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/operations/listworkspacesglobals.mdx b/docs/operations/listworkspacesglobals.mdx index 8e6cf8715..2a6be98ca 100644 --- a/docs/operations/listworkspacesglobals.mdx +++ b/docs/operations/listworkspacesglobals.mdx @@ -6,6 +6,6 @@ title: "ListWorkspacesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listworkspacesrequest.mdx b/docs/operations/listworkspacesrequest.mdx index fdd280c97..0903d08e1 100644 --- a/docs/operations/listworkspacesrequest.mdx +++ b/docs/operations/listworkspacesrequest.mdx @@ -6,8 +6,8 @@ title: "ListWorkspacesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listworkspacesresponse.mdx b/docs/operations/listworkspacesresponse.mdx index c51d303d2..44258f9aa 100644 --- a/docs/operations/listworkspacesresponse.mdx +++ b/docs/operations/listworkspacesresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListWorkspacesResponse](../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](../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/operations/metadata.mdx b/docs/operations/metadata.mdx index 87a43d799..33c6b11a5 100644 --- a/docs/operations/metadata.mdx +++ b/docs/operations/metadata.mdx @@ -6,6 +6,6 @@ title: "Metadata" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `query_time_ms` | *float* | ✅ | N/A | -| `row_count` | *int* | ✅ | N/A | -| `truncated` | *bool* | ✅ | N/A | \ No newline at end of file +| `query_time_ms` | *float* | :heavy_check_mark: | N/A | +| `row_count` | *int* | :heavy_check_mark: | N/A | +| `truncated` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/metric.mdx b/docs/operations/metric.mdx index d2520eaca..a1b3a3e10 100644 --- a/docs/operations/metric.mdx +++ b/docs/operations/metric.mdx @@ -6,7 +6,7 @@ title: "Metric" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `display_format` | [operations.DisplayFormat](../operations/displayformat.mdx) | ✅ | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | -| `display_label` | *str* | ✅ | Human-readable label | Request Count | -| `is_rate` | *bool* | ✅ | Whether this metric is a rate/ratio (averaged, not summed) | | -| `name` | *str* | ✅ | Metric identifier used in query requests | request_count | \ No newline at end of file +| `display_format` | [operations.DisplayFormat](../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 | +| `display_label` | *str* | :heavy_check_mark: | Human-readable label | Request Count | +| `is_rate` | *bool* | :heavy_check_mark: | Whether this metric is a rate/ratio (averaged, not summed) | | +| `name` | *str* | :heavy_check_mark: | Metric identifier used in query requests | request_count | \ No newline at end of file diff --git a/docs/operations/operator.mdx b/docs/operations/operator.mdx index 9f83faabf..f14d7d1a7 100644 --- a/docs/operations/operator.mdx +++ b/docs/operations/operator.mdx @@ -6,5 +6,5 @@ title: "Operator" | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `name` | [operations.OperatorName](../operations/operatorname.mdx) | ✅ | Operator identifier used in filter definitions | eq | -| `value_type` | [operations.ValueType](../operations/valuetype.mdx) | ✅ | Whether the operator expects a single value or an array | | \ No newline at end of file +| `name` | [operations.OperatorName](../operations/operatorname.mdx) | :heavy_check_mark: | Operator identifier used in filter definitions | eq | +| `value_type` | [operations.ValueType](../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/operations/orderby.mdx b/docs/operations/orderby.mdx index f15afa9e3..d2239ff9d 100644 --- a/docs/operations/orderby.mdx +++ b/docs/operations/orderby.mdx @@ -6,5 +6,5 @@ title: "OrderBy" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `direction` | [operations.Direction](../operations/direction.mdx) | ✅ | N/A | | -| `field` | *str* | ✅ | 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](../operations/direction.mdx) | :heavy_check_mark: | N/A | | +| `field` | *str* | :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/operations/promotecontainerfileglobals.mdx b/docs/operations/promotecontainerfileglobals.mdx index 9bc4f4ea3..f1aa90ac4 100644 --- a/docs/operations/promotecontainerfileglobals.mdx +++ b/docs/operations/promotecontainerfileglobals.mdx @@ -6,6 +6,6 @@ title: "PromoteContainerFileGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/promotecontainerfilerequest.mdx b/docs/operations/promotecontainerfilerequest.mdx index 31730e276..a14427c49 100644 --- a/docs/operations/promotecontainerfilerequest.mdx +++ b/docs/operations/promotecontainerfilerequest.mdx @@ -6,8 +6,8 @@ title: "PromoteContainerFileRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `container_id` | *str* | ✅ | 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 | -| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `container_id` | *str* | :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 | +| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/operations/prompttokensdetails.mdx b/docs/operations/prompttokensdetails.mdx index edbbce363..0f0b54e43 100644 --- a/docs/operations/prompttokensdetails.mdx +++ b/docs/operations/prompttokensdetails.mdx @@ -9,8 +9,8 @@ Per-modality token breakdown. Only present when the input contains 2+ modalities | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `audio_tokens` | *Optional[int]* | ➖ | Number of audio tokens in the input | | -| `file_tokens` | *Optional[int]* | ➖ | Number of file/document tokens in the input | | -| `image_tokens` | *Optional[int]* | ➖ | Number of image tokens in the input | 258 | -| `text_tokens` | *Optional[int]* | ➖ | Number of text tokens in the input | 8 | -| `video_tokens` | *Optional[int]* | ➖ | Number of video tokens in the input | | \ No newline at end of file +| `audio_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of audio tokens in the input | | +| `file_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of file/document tokens in the input | | +| `image_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of image tokens in the input | 258 | +| `text_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of text tokens in the input | 8 | +| `video_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/operations/provisioninternglobals.mdx b/docs/operations/provisioninternglobals.mdx index 05197d7f4..5e790162a 100644 --- a/docs/operations/provisioninternglobals.mdx +++ b/docs/operations/provisioninternglobals.mdx @@ -6,6 +6,6 @@ title: "ProvisionInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/provisioninternrequest.mdx b/docs/operations/provisioninternrequest.mdx index 19527e6ea..5c14eb74f 100644 --- a/docs/operations/provisioninternrequest.mdx +++ b/docs/operations/provisioninternrequest.mdx @@ -6,7 +6,7 @@ title: "ProvisionInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :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/operations/queryanalyticsdata2.mdx b/docs/operations/queryanalyticsdata2.mdx index 3901d64bb..669a0894f 100644 --- a/docs/operations/queryanalyticsdata2.mdx +++ b/docs/operations/queryanalyticsdata2.mdx @@ -6,7 +6,7 @@ title: "QueryAnalyticsData2" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cached_at` | *Optional[float]* | ➖ | N/A | -| `data` | List[[operations.QueryAnalyticsData1](../operations/queryanalyticsdata1.mdx)] | ✅ | N/A | -| `metadata` | [operations.Metadata](../operations/metadata.mdx) | ✅ | N/A | -| `warnings` | List[*str*] | ➖ | 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 +| `cached_at` | *Optional[float]* | :heavy_minus_sign: | N/A | +| `data` | List[[operations.QueryAnalyticsData1](../operations/queryanalyticsdata1.mdx)] | :heavy_check_mark: | N/A | +| `metadata` | [operations.Metadata](../operations/metadata.mdx) | :heavy_check_mark: | N/A | +| `warnings` | List[*str*] | :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/operations/queryanalyticsglobals.mdx b/docs/operations/queryanalyticsglobals.mdx index 7f9c63bec..d808bb399 100644 --- a/docs/operations/queryanalyticsglobals.mdx +++ b/docs/operations/queryanalyticsglobals.mdx @@ -6,6 +6,6 @@ title: "QueryAnalyticsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/queryanalyticsrequest.mdx b/docs/operations/queryanalyticsrequest.mdx index 08ca67e33..5b3c7c98d 100644 --- a/docs/operations/queryanalyticsrequest.mdx +++ b/docs/operations/queryanalyticsrequest.mdx @@ -6,7 +6,7 @@ title: "QueryAnalyticsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `request_body` | [operations.QueryAnalyticsRequestBody](../operations/queryanalyticsrequestbody.mdx) | ✅ | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `request_body` | [operations.QueryAnalyticsRequestBody](../operations/queryanalyticsrequestbody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/queryanalyticsrequestbody.mdx b/docs/operations/queryanalyticsrequestbody.mdx index 0b9ab4fef..ceec61fa2 100644 --- a/docs/operations/queryanalyticsrequestbody.mdx +++ b/docs/operations/queryanalyticsrequestbody.mdx @@ -6,13 +6,13 @@ title: "QueryAnalyticsRequestBody" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `classifier_dimensions` | [Optional[operations.ClassifierDimensions]](../operations/classifierdimensions.mdx) | ➖ | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | -| `classifier_filters` | [Optional[operations.ClassifierFilters]](../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` | List[*str*] | ➖ | N/A | | -| `filters` | List[[operations.Filter](../operations/filter_.mdx)] | ➖ | N/A | | -| `granularity` | *Optional[str]* | ➖ | Time granularity | day | -| `group_limit` | *Optional[int]* | ➖ | 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` | *Optional[int]* | ➖ | 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` | List[*str*] | ✅ | N/A | | -| `order_by` | [Optional[operations.OrderBy]](../operations/orderby.mdx) | ➖ | N/A | | -| `time_range` | [Optional[operations.TimeRange]](../operations/timerange.mdx) | ➖ | N/A | | \ No newline at end of file +| `classifier_dimensions` | [Optional[operations.ClassifierDimensions]](../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. | | +| `classifier_filters` | [Optional[operations.ClassifierFilters]](../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` | List[*str*] | :heavy_minus_sign: | N/A | | +| `filters` | List[[operations.Filter](../operations/filter_.mdx)] | :heavy_minus_sign: | N/A | | +| `granularity` | *Optional[str]* | :heavy_minus_sign: | Time granularity | day | +| `group_limit` | *Optional[int]* | :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` | *Optional[int]* | :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` | List[*str*] | :heavy_check_mark: | N/A | | +| `order_by` | [Optional[operations.OrderBy]](../operations/orderby.mdx) | :heavy_minus_sign: | N/A | | +| `time_range` | [Optional[operations.TimeRange]](../operations/timerange.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/operations/queryanalyticsresponse.mdx b/docs/operations/queryanalyticsresponse.mdx index a5d3e8568..6c45e2170 100644 --- a/docs/operations/queryanalyticsresponse.mdx +++ b/docs/operations/queryanalyticsresponse.mdx @@ -9,4 +9,4 @@ Analytics query results | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [operations.QueryAnalyticsData2](../operations/queryanalyticsdata2.mdx) | ✅ | N/A | \ No newline at end of file +| `data` | [operations.QueryAnalyticsData2](../operations/queryanalyticsdata2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/ratelimit.mdx b/docs/operations/ratelimit.mdx index 9f3599e56..f1aa5276e 100644 --- a/docs/operations/ratelimit.mdx +++ b/docs/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` | *str* | ✅ | Rate limit interval | 1h | -| `note` | *str* | ✅ | Note about the rate limit | This field is deprecated and safe to ignore. | -| `requests` | *int* | ✅ | Number of requests allowed per interval | 1000 | \ No newline at end of file +| `interval` | *str* | :heavy_check_mark: | Rate limit interval | 1h | +| `note` | *str* | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | +| `requests` | *int* | :heavy_check_mark: | Number of requests allowed per interval | 1000 | \ No newline at end of file diff --git a/docs/operations/result.mdx b/docs/operations/result.mdx index 9a0d2a076..510072b9f 100644 --- a/docs/operations/result.mdx +++ b/docs/operations/result.mdx @@ -9,6 +9,6 @@ A single rerank result | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `document` | [operations.DocumentResponse](../operations/documentresponse.mdx) | ✅ | The document object echoing the original input (text and/or image) | | -| `index` | *int* | ✅ | Index of the document in the original input list | 0 | -| `relevance_score` | *float* | ✅ | Relevance score of the document to the query | 0.98 | \ No newline at end of file +| `document` | [operations.DocumentResponse](../operations/documentresponse.mdx) | :heavy_check_mark: | The document object echoing the original input (text and/or image) | | +| `index` | *int* | :heavy_check_mark: | Index of the document in the original input list | 0 | +| `relevance_score` | *float* | :heavy_check_mark: | Relevance score of the document to the query | 0.98 | \ No newline at end of file diff --git a/docs/operations/sendchatcompletionrequestglobals.mdx b/docs/operations/sendchatcompletionrequestglobals.mdx index ec68ddea4..290c9540b 100644 --- a/docs/operations/sendchatcompletionrequestglobals.mdx +++ b/docs/operations/sendchatcompletionrequestglobals.mdx @@ -6,6 +6,6 @@ title: "SendChatCompletionRequestGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/sendchatcompletionrequestrequest.mdx b/docs/operations/sendchatcompletionrequestrequest.mdx index a06e2f6ea..bd3e6d5c1 100644 --- a/docs/operations/sendchatcompletionrequestrequest.mdx +++ b/docs/operations/sendchatcompletionrequestrequest.mdx @@ -6,8 +6,8 @@ title: "SendChatCompletionRequestRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../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 | -| `chat_request` | [components.ChatRequest](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../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 | +| `chat_request` | [components.ChatRequest](../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/operations/signinterndaemonaccessrequestglobals.mdx b/docs/operations/signinterndaemonaccessrequestglobals.mdx index 38e573620..44569250d 100644 --- a/docs/operations/signinterndaemonaccessrequestglobals.mdx +++ b/docs/operations/signinterndaemonaccessrequestglobals.mdx @@ -6,6 +6,6 @@ title: "SignInternDaemonAccessRequestGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/signinterndaemonaccessrequestrequest.mdx b/docs/operations/signinterndaemonaccessrequestrequest.mdx index bad498735..1816b6092 100644 --- a/docs/operations/signinterndaemonaccessrequestrequest.mdx +++ b/docs/operations/signinterndaemonaccessrequestrequest.mdx @@ -6,8 +6,8 @@ title: "SignInternDaemonAccessRequestRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `sign_intern_daemon_request` | [components.SignInternDaemonRequest](../components/signinterndaemonrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `sign_intern_daemon_request` | [components.SignInternDaemonRequest](../components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/operations/signinterndaemonaccessrequestresponse.mdx b/docs/operations/signinterndaemonaccessrequestresponse.mdx index 6e1f966ae..83bc490dc 100644 --- a/docs/operations/signinterndaemonaccessrequestresponse.mdx +++ b/docs/operations/signinterndaemonaccessrequestresponse.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonAccessRequestResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | ✅ | N/A | | -| `result` | [components.SignInternDaemonResponse](../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` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | | +| `result` | [components.SignInternDaemonResponse](../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/operations/signinterndaemonrequestglobals.mdx b/docs/operations/signinterndaemonrequestglobals.mdx index 4d4018dbd..488b9b063 100644 --- a/docs/operations/signinterndaemonrequestglobals.mdx +++ b/docs/operations/signinterndaemonrequestglobals.mdx @@ -6,6 +6,6 @@ title: "SignInternDaemonRequestGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/signinterndaemonrequestrequest.mdx b/docs/operations/signinterndaemonrequestrequest.mdx index 29a5ad132..afc21adef 100644 --- a/docs/operations/signinterndaemonrequestrequest.mdx +++ b/docs/operations/signinterndaemonrequestrequest.mdx @@ -6,8 +6,8 @@ title: "SignInternDaemonRequestRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `sign_intern_daemon_request` | [components.SignInternDaemonRequest](../components/signinterndaemonrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `sign_intern_daemon_request` | [components.SignInternDaemonRequest](../components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/operations/signinterndaemonrequestresponse.mdx b/docs/operations/signinterndaemonrequestresponse.mdx index 7d4277674..068696580 100644 --- a/docs/operations/signinterndaemonrequestresponse.mdx +++ b/docs/operations/signinterndaemonrequestresponse.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonRequestResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | ✅ | N/A | | -| `result` | [components.SignInternDaemonResponse](../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` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | | +| `result` | [components.SignInternDaemonResponse](../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/operations/storeinternvaultsecretglobals.mdx b/docs/operations/storeinternvaultsecretglobals.mdx index 799434f5c..e7c3b3f7a 100644 --- a/docs/operations/storeinternvaultsecretglobals.mdx +++ b/docs/operations/storeinternvaultsecretglobals.mdx @@ -6,6 +6,6 @@ title: "StoreInternVaultSecretGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/storeinternvaultsecretrequest.mdx b/docs/operations/storeinternvaultsecretrequest.mdx index f1df8d4ba..fe38c09ab 100644 --- a/docs/operations/storeinternvaultsecretrequest.mdx +++ b/docs/operations/storeinternvaultsecretrequest.mdx @@ -6,9 +6,9 @@ title: "StoreInternVaultSecretRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `vault_secret_write_request` | [components.VaultSecretWriteRequest](../components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *str* | :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 | +| `vault_secret_write_request` | [components.VaultSecretWriteRequest](../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/operations/storevaultsecretglobals.mdx b/docs/operations/storevaultsecretglobals.mdx index 22bcb1e07..6cb21606c 100644 --- a/docs/operations/storevaultsecretglobals.mdx +++ b/docs/operations/storevaultsecretglobals.mdx @@ -6,6 +6,6 @@ title: "StoreVaultSecretGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/storevaultsecretrequest.mdx b/docs/operations/storevaultsecretrequest.mdx index 64ffb5bd7..e8571eae3 100644 --- a/docs/operations/storevaultsecretrequest.mdx +++ b/docs/operations/storevaultsecretrequest.mdx @@ -6,8 +6,8 @@ title: "StoreVaultSecretRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `vault_secret_write_request` | [components.VaultSecretWriteRequest](../components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `name` | *str* | :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 | +| `vault_secret_write_request` | [components.VaultSecretWriteRequest](../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/operations/submitgenerationfeedbackglobals.mdx b/docs/operations/submitgenerationfeedbackglobals.mdx index 44e60ea92..bbd731b6f 100644 --- a/docs/operations/submitgenerationfeedbackglobals.mdx +++ b/docs/operations/submitgenerationfeedbackglobals.mdx @@ -6,6 +6,6 @@ title: "SubmitGenerationFeedbackGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/submitgenerationfeedbackrequest.mdx b/docs/operations/submitgenerationfeedbackrequest.mdx index 507162ed7..18f5cc3e2 100644 --- a/docs/operations/submitgenerationfeedbackrequest.mdx +++ b/docs/operations/submitgenerationfeedbackrequest.mdx @@ -6,7 +6,7 @@ title: "SubmitGenerationFeedbackRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `submit_generation_feedback_request` | [components.SubmitGenerationFeedbackRequest](../components/submitgenerationfeedbackrequest.mdx) | ✅ | N/A | \{
"category": "incorrect_response",
"comment": "The model repeated the same paragraph three times.",
"generation_id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `submit_generation_feedback_request` | [components.SubmitGenerationFeedbackRequest](../components/submitgenerationfeedbackrequest.mdx) | :heavy_check_mark: | N/A | \{
"category": "incorrect_response",
"comment": "The model repeated the same paragraph three times.",
"generation_id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG"
} | \ No newline at end of file diff --git a/docs/operations/suspendinternglobals.mdx b/docs/operations/suspendinternglobals.mdx index 1d1c22fbb..3837a6174 100644 --- a/docs/operations/suspendinternglobals.mdx +++ b/docs/operations/suspendinternglobals.mdx @@ -6,6 +6,6 @@ title: "SuspendInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/suspendinternrequest.mdx b/docs/operations/suspendinternrequest.mdx index 6bd3bcbf4..d039292f1 100644 --- a/docs/operations/suspendinternrequest.mdx +++ b/docs/operations/suspendinternrequest.mdx @@ -6,7 +6,7 @@ title: "SuspendInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :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/operations/timerange.mdx b/docs/operations/timerange.mdx index 4cce4dcbb..a7077e81b 100644 --- a/docs/operations/timerange.mdx +++ b/docs/operations/timerange.mdx @@ -6,5 +6,5 @@ title: "TimeRange" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `end` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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/operations/updatebyokkeyglobals.mdx b/docs/operations/updatebyokkeyglobals.mdx index 676e2ae49..905abf791 100644 --- a/docs/operations/updatebyokkeyglobals.mdx +++ b/docs/operations/updatebyokkeyglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateBYOKKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updatebyokkeyrequest.mdx b/docs/operations/updatebyokkeyrequest.mdx index fa8d4fa00..546e001df 100644 --- a/docs/operations/updatebyokkeyrequest.mdx +++ b/docs/operations/updatebyokkeyrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `update_byok_key_request` | [components.UpdateBYOKKeyRequest](../components/updatebyokkeyrequest.mdx) | ✅ | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `update_byok_key_request` | [components.UpdateBYOKKeyRequest](../components/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file diff --git a/docs/operations/updateenduserglobals.mdx b/docs/operations/updateenduserglobals.mdx index f0004a028..de504b1ca 100644 --- a/docs/operations/updateenduserglobals.mdx +++ b/docs/operations/updateenduserglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateEndUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateenduserrequest.mdx b/docs/operations/updateenduserrequest.mdx index 76b7792cf..6ff8bd561 100644 --- a/docs/operations/updateenduserrequest.mdx +++ b/docs/operations/updateenduserrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `user` | *str* | ✅ | 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 | -| `update_end_user_request` | [components.UpdateEndUserRequest](../components/updateenduserrequest.mdx) | ✅ | N/A | \{
"is_active": true
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `user` | *str* | :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 | +| `update_end_user_request` | [components.UpdateEndUserRequest](../components/updateenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"is_active": true
} | \ No newline at end of file diff --git a/docs/operations/updateguardrailglobals.mdx b/docs/operations/updateguardrailglobals.mdx index 0897cc9c1..0cd4bcb1e 100644 --- a/docs/operations/updateguardrailglobals.mdx +++ b/docs/operations/updateguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateguardrailrequest.mdx b/docs/operations/updateguardrailrequest.mdx index 5dcca590d..b89a6072a 100644 --- a/docs/operations/updateguardrailrequest.mdx +++ b/docs/operations/updateguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `update_guardrail_request` | [components.UpdateGuardrailRequest](../components/updateguardrailrequest.mdx) | ✅ | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | +| `update_guardrail_request` | [components.UpdateGuardrailRequest](../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/operations/updateinternglobals.mdx b/docs/operations/updateinternglobals.mdx index cb55402b0..ef2e16315 100644 --- a/docs/operations/updateinternglobals.mdx +++ b/docs/operations/updateinternglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateinternrequest.mdx b/docs/operations/updateinternrequest.mdx index 179bb1dfa..059a2165b 100644 --- a/docs/operations/updateinternrequest.mdx +++ b/docs/operations/updateinternrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `update_intern_request` | [components.UpdateInternRequest](../components/updateinternrequest.mdx) | ✅ | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `update_intern_request` | [components.UpdateInternRequest](../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/operations/updatekeysdata.mdx b/docs/operations/updatekeysdata.mdx index 8ecbb6a93..46e464000 100644 --- a/docs/operations/updatekeysdata.mdx +++ b/docs/operations/updatekeysdata.mdx @@ -9,26 +9,26 @@ The updated API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | ✅ | 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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `external_user` | *Nullable[str]* | ✅ | Partner's end-user identifier used for attribution. | null | -| `hash` | *str* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | -| `name` | *str* | ✅ | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creator_user_id` | *Nullable[str]* | :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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `external_user` | *Nullable[str]* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | +| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | +| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *str* | :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/operations/updatekeysglobals.mdx b/docs/operations/updatekeysglobals.mdx index a1cd92e3c..2b4abc3fc 100644 --- a/docs/operations/updatekeysglobals.mdx +++ b/docs/operations/updatekeysglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateKeysGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updatekeysrequest.mdx b/docs/operations/updatekeysrequest.mdx index e3ea21921..e6d3d7f01 100644 --- a/docs/operations/updatekeysrequest.mdx +++ b/docs/operations/updatekeysrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *str* | ✅ | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `request_body` | [operations.UpdateKeysRequestBody](../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 +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `request_body` | [operations.UpdateKeysRequestBody](../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/operations/updatekeysrequestbody.mdx b/docs/operations/updatekeysrequestbody.mdx index 9cf47d247..bc08a2d46 100644 --- a/docs/operations/updatekeysrequestbody.mdx +++ b/docs/operations/updatekeysrequestbody.mdx @@ -6,9 +6,9 @@ title: "UpdateKeysRequestBody" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `disabled` | *Optional[bool]* | ➖ | Whether to disable the API key | false | -| `include_byok_in_limit` | *Optional[bool]* | ➖ | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | ➖ | New spending limit for the API key in USD | 75 | -| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../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` | *Optional[str]* | ➖ | New name for the API key | Updated API Key Name | -| `workspace_id` | *Optional[str]* | ➖ | Move the API key to this workspace. The key keeps its value; guardrail selections move with it, while other workspace-scoped settings (presets, BYOK keys, broadcast destinations, routing rules) do not. Sending the key's current workspace is a no-op. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to disable the API key | false | +| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | +| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | +| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../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` | *Optional[str]* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Move the API key to this workspace. The key keeps its value; guardrail selections move with it, while other workspace-scoped settings (presets, BYOK keys, broadcast destinations, routing rules) do not. Sending the key's current workspace is a no-op. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/operations/updatekeysresponse.mdx b/docs/operations/updatekeysresponse.mdx index 1512882c6..9440f9f6b 100644 --- a/docs/operations/updatekeysresponse.mdx +++ b/docs/operations/updatekeysresponse.mdx @@ -9,4 +9,4 @@ API key updated successfully | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.UpdateKeysData](../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](../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/operations/updateobservabilitydestinationglobals.mdx b/docs/operations/updateobservabilitydestinationglobals.mdx index 4cc38c4a3..f5a0ba069 100644 --- a/docs/operations/updateobservabilitydestinationglobals.mdx +++ b/docs/operations/updateobservabilitydestinationglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateObservabilityDestinationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateobservabilitydestinationrequest.mdx b/docs/operations/updateobservabilitydestinationrequest.mdx index 1f03ef4d8..169263831 100644 --- a/docs/operations/updateobservabilitydestinationrequest.mdx +++ b/docs/operations/updateobservabilitydestinationrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `update_observability_destination_request` | [components.UpdateObservabilityDestinationRequest](../components/updateobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `update_observability_destination_request` | [components.UpdateObservabilityDestinationRequest](../components/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file diff --git a/docs/operations/updateorganizationsettingsglobals.mdx b/docs/operations/updateorganizationsettingsglobals.mdx index f9a837442..6c32aff3a 100644 --- a/docs/operations/updateorganizationsettingsglobals.mdx +++ b/docs/operations/updateorganizationsettingsglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateOrganizationSettingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateorganizationsettingsrequest.mdx b/docs/operations/updateorganizationsettingsrequest.mdx index b35d1c40a..014eb8dbe 100644 --- a/docs/operations/updateorganizationsettingsrequest.mdx +++ b/docs/operations/updateorganizationsettingsrequest.mdx @@ -6,7 +6,7 @@ title: "UpdateOrganizationSettingsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `update_organization_settings_request` | [components.UpdateOrganizationSettingsRequest](../components/updateorganizationsettingsrequest.mdx) | ✅ | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `update_organization_settings_request` | [components.UpdateOrganizationSettingsRequest](../components/updateorganizationsettingsrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/updateorganizationsettingsresponse.mdx b/docs/operations/updateorganizationsettingsresponse.mdx index ccc6b67ea..b811bffe1 100644 --- a/docs/operations/updateorganizationsettingsresponse.mdx +++ b/docs/operations/updateorganizationsettingsresponse.mdx @@ -9,4 +9,4 @@ Organization settings updated successfully | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [components.OrganizationSettings](../components/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file +| `data` | [components.OrganizationSettings](../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/operations/updateprivateendpointglobals.mdx b/docs/operations/updateprivateendpointglobals.mdx index 99aa01601..3624f9a24 100644 --- a/docs/operations/updateprivateendpointglobals.mdx +++ b/docs/operations/updateprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "UpdatePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateprivateendpointpricingglobals.mdx b/docs/operations/updateprivateendpointpricingglobals.mdx index 6ad2cba06..3fea3054b 100644 --- a/docs/operations/updateprivateendpointpricingglobals.mdx +++ b/docs/operations/updateprivateendpointpricingglobals.mdx @@ -6,6 +6,6 @@ title: "UpdatePrivateEndpointPricingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateprivateendpointpricingrequest.mdx b/docs/operations/updateprivateendpointpricingrequest.mdx index 50e3535fd..4b77bff2c 100644 --- a/docs/operations/updateprivateendpointpricingrequest.mdx +++ b/docs/operations/updateprivateendpointpricingrequest.mdx @@ -6,8 +6,8 @@ title: "UpdatePrivateEndpointPricingRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `update_private_endpoint_pricing_request` | [components.UpdatePrivateEndpointPricingRequest](../components/updateprivateendpointpricingrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `update_private_endpoint_pricing_request` | [components.UpdatePrivateEndpointPricingRequest](../components/updateprivateendpointpricingrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/operations/updateprivateendpointrequest.mdx b/docs/operations/updateprivateendpointrequest.mdx index 216dd97dc..45632457e 100644 --- a/docs/operations/updateprivateendpointrequest.mdx +++ b/docs/operations/updateprivateendpointrequest.mdx @@ -6,8 +6,8 @@ title: "UpdatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `update_private_endpoint_request` | [components.UpdatePrivateEndpointRequest](../components/updateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `update_private_endpoint_request` | [components.UpdatePrivateEndpointRequest](../components/updateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/operations/updatescimgroupmappingglobals.mdx b/docs/operations/updatescimgroupmappingglobals.mdx index 1b82d6be7..a8893db66 100644 --- a/docs/operations/updatescimgroupmappingglobals.mdx +++ b/docs/operations/updatescimgroupmappingglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateScimGroupMappingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updatescimgroupmappingrequest.mdx b/docs/operations/updatescimgroupmappingrequest.mdx index c341f7622..a2785d524 100644 --- a/docs/operations/updatescimgroupmappingrequest.mdx +++ b/docs/operations/updatescimgroupmappingrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `id` | *str* | ✅ | N/A | -| `update_scim_group_mapping_request` | [components.UpdateScimGroupMappingRequest](../components/updatescimgroupmappingrequest.mdx) | ✅ | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `id` | *str* | :heavy_check_mark: | N/A | +| `update_scim_group_mapping_request` | [components.UpdateScimGroupMappingRequest](../components/updatescimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/updateworkspaceglobals.mdx b/docs/operations/updateworkspaceglobals.mdx index e1c253c39..34ddab96d 100644 --- a/docs/operations/updateworkspaceglobals.mdx +++ b/docs/operations/updateworkspaceglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateWorkspaceGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateworkspacerequest.mdx b/docs/operations/updateworkspacerequest.mdx index 993917254..086cdf63d 100644 --- a/docs/operations/updateworkspacerequest.mdx +++ b/docs/operations/updateworkspacerequest.mdx @@ -6,8 +6,8 @@ title: "UpdateWorkspaceRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `update_workspace_request` | [components.UpdateWorkspaceRequest](../components/updateworkspacerequest.mdx) | ✅ | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `update_workspace_request` | [components.UpdateWorkspaceRequest](../components/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file diff --git a/docs/operations/uploadfilefile.mdx b/docs/operations/uploadfilefile.mdx index 454042271..f07c77ddf 100644 --- a/docs/operations/uploadfilefile.mdx +++ b/docs/operations/uploadfilefile.mdx @@ -6,6 +6,6 @@ title: "UploadFileFile" | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `file_name` | *str* | ✅ | N/A | -| `content` | *Union[bytes, IO[bytes], io.IOBase]* | ✅ | N/A | -| `content_type` | *Optional[str]* | ➖ | N/A | \ No newline at end of file +| `file_name` | *str* | :heavy_check_mark: | N/A | +| `content` | *Union[bytes, IO[bytes], io.IOBase]* | :heavy_check_mark: | N/A | +| `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/operations/uploadfileglobals.mdx b/docs/operations/uploadfileglobals.mdx index 534573027..41aa595e2 100644 --- a/docs/operations/uploadfileglobals.mdx +++ b/docs/operations/uploadfileglobals.mdx @@ -6,6 +6,6 @@ title: "UploadFileGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/uploadfilerequest.mdx b/docs/operations/uploadfilerequest.mdx index cc87b0f26..16d9fbce0 100644 --- a/docs/operations/uploadfilerequest.mdx +++ b/docs/operations/uploadfilerequest.mdx @@ -6,9 +6,9 @@ title: "UploadFileRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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 | -| `request_body` | [operations.UploadFileRequestBody](../operations/uploadfilerequestbody.mdx) | ✅ | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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 | +| `request_body` | [operations.UploadFileRequestBody](../operations/uploadfilerequestbody.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/operations/uploadfilerequestbody.mdx b/docs/operations/uploadfilerequestbody.mdx index adf966ae0..e91f2d375 100644 --- a/docs/operations/uploadfilerequestbody.mdx +++ b/docs/operations/uploadfilerequestbody.mdx @@ -6,4 +6,4 @@ title: "UploadFileRequestBody" | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `file` | [operations.UploadFileFile](../operations/uploadfilefile.mdx) | ✅ | N/A | \ No newline at end of file +| `file` | [operations.UploadFileFile](../operations/uploadfilefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/operations/upsertworkspacebudgetglobals.mdx b/docs/operations/upsertworkspacebudgetglobals.mdx index a9b8e0266..67a0d7d1d 100644 --- a/docs/operations/upsertworkspacebudgetglobals.mdx +++ b/docs/operations/upsertworkspacebudgetglobals.mdx @@ -6,6 +6,6 @@ title: "UpsertWorkspaceBudgetGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/upsertworkspacebudgetrequest.mdx b/docs/operations/upsertworkspacebudgetrequest.mdx index fd6c4250d..6c23bcff4 100644 --- a/docs/operations/upsertworkspacebudgetrequest.mdx +++ b/docs/operations/upsertworkspacebudgetrequest.mdx @@ -6,9 +6,9 @@ title: "UpsertWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `upsert_workspace_budget_request` | [components.UpsertWorkspaceBudgetRequest](../components/upsertworkspacebudgetrequest.mdx) | ✅ | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `upsert_workspace_budget_request` | [components.UpsertWorkspaceBudgetRequest](../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/operations/validateprivateendpointglobals.mdx b/docs/operations/validateprivateendpointglobals.mdx index af7c2932f..e539875f6 100644 --- a/docs/operations/validateprivateendpointglobals.mdx +++ b/docs/operations/validateprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "ValidatePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/validateprivateendpointrequest.mdx b/docs/operations/validateprivateendpointrequest.mdx index 12245fab6..d61a27f50 100644 --- a/docs/operations/validateprivateendpointrequest.mdx +++ b/docs/operations/validateprivateendpointrequest.mdx @@ -6,8 +6,8 @@ title: "ValidatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `validate_private_endpoint_request` | [components.ValidatePrivateEndpointRequest](../components/validateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `validate_private_endpoint_request` | [components.ValidatePrivateEndpointRequest](../components/validateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/sdks/analytics/README.mdx b/docs/sdks/analytics/README.mdx index 3f0c2dcf2..c16347066 100644 --- a/docs/sdks/analytics/README.mdx +++ b/docs/sdks/analytics/README.mdx @@ -42,8 +42,8 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `request` | [operations.GetUserActivityRequest](../../operations/getuseractivityrequest.mdx) | ✅ | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `request` | [operations.GetUserActivityRequest](../../operations/getuseractivityrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -89,10 +89,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -144,20 +144,20 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metrics` | List[*str*] | ✅ | N/A | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `classifier_dimensions` | [Optional[operations.ClassifierDimensions]](../../operations/classifierdimensions.mdx) | ➖ | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | -| `classifier_filters` | [Optional[operations.ClassifierFilters]](../../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` | List[*str*] | ➖ | N/A | | -| `filters` | List[[operations.Filter](../../operations/filter_.mdx)] | ➖ | N/A | | -| `granularity` | *Optional[str]* | ➖ | Time granularity | day | -| `group_limit` | *Optional[int]* | ➖ | 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` | *Optional[int]* | ➖ | 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. | | -| `order_by` | [Optional[operations.OrderBy]](../../operations/orderby.mdx) | ➖ | N/A | | -| `time_range` | [Optional[operations.TimeRange]](../../operations/timerange.mdx) | ➖ | N/A | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `metrics` | List[*str*] | :heavy_check_mark: | N/A | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `classifier_dimensions` | [Optional[operations.ClassifierDimensions]](../../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. | | +| `classifier_filters` | [Optional[operations.ClassifierFilters]](../../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` | List[*str*] | :heavy_minus_sign: | N/A | | +| `filters` | List[[operations.Filter](../../operations/filter_.mdx)] | :heavy_minus_sign: | N/A | | +| `granularity` | *Optional[str]* | :heavy_minus_sign: | Time granularity | day | +| `group_limit` | *Optional[int]* | :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` | *Optional[int]* | :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. | | +| `order_by` | [Optional[operations.OrderBy]](../../operations/orderby.mdx) | :heavy_minus_sign: | N/A | | +| `time_range` | [Optional[operations.TimeRange]](../../operations/timerange.mdx) | :heavy_minus_sign: | N/A | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/apikeys/README.mdx b/docs/sdks/apikeys/README.mdx index 6cdaed22a..959c9469a 100644 --- a/docs/sdks/apikeys/README.mdx +++ b/docs/sdks/apikeys/README.mdx @@ -45,10 +45,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -91,14 +91,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `include_disabled` | *Optional[bool]* | ➖ | Whether to include disabled API keys in the response | false | -| `include_expired` | *Optional[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[int]* | ➖ | Number of API keys to skip for pagination | 0 | -| `workspace_id` | *Optional[str]* | ➖ | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `include_disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | +| `include_expired` | *Optional[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[int]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -144,18 +144,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | ✅ | Name for the new API key | My New API Key | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `creator_user_id` | *OptionalNullable[str]* | ➖ | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | 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` | [Optional[operations.External]](../../operations/external.mdx) | ➖ | Optional partner-defined identity associated with the created API key. | | -| `include_byok_in_limit` | *Optional[bool]* | ➖ | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | ➖ | Optional spending limit for the API key in USD | 50 | -| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../../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 | -| `workspace_id` | *Optional[str]* | ➖ | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `creator_user_id` | *OptionalNullable[str]* | :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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | [Optional[operations.External]](../../operations/external.mdx) | :heavy_minus_sign: | Optional partner-defined identity associated with the created API key. | | +| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | +| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | +| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../../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 | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -201,11 +201,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | ✅ | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -250,11 +250,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | ✅ | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -325,17 +325,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | ✅ | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `disabled` | *Optional[bool]* | ➖ | Whether to disable the API key | false | -| `include_byok_in_limit` | *Optional[bool]* | ➖ | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | ➖ | New spending limit for the API key in USD | 75 | -| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../../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` | *Optional[str]* | ➖ | New name for the API key | Updated API Key Name | -| `workspace_id` | *Optional[str]* | ➖ | Move the API key to this workspace. The key keeps its value; guardrail selections move with it, while other workspace-scoped settings (presets, BYOK keys, broadcast destinations, routing rules) do not. Sending the key's current workspace is a no-op. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to disable the API key | false | +| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | +| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | +| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../../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` | *Optional[str]* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Move the API key to this workspace. The key keeps its value; guardrail selections move with it, while other workspace-scoped settings (presets, BYOK keys, broadcast destinations, routing rules) do not. Sending the key's current workspace is a no-op. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/batch/README.mdx b/docs/sdks/batch/README.mdx index c7f0cd1dc..9fb69f19b 100644 --- a/docs/sdks/batch/README.mdx +++ b/docs/sdks/batch/README.mdx @@ -45,15 +45,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Maximum number of batches to return, from 1 through 100. | 20 | -| `after` | *Optional[str]* | ➖ | Batch id from the previous page's `last_id`. | batch_7a4b02 | -| `status` | List[[components.BatchListStatus](../../components/batchliststatus.mdx)] | ➖ | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | -| `created_after` | [Optional[components.BatchListTimestamp]](../../components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | -| `created_before` | [Optional[components.BatchListTimestamp]](../../components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of batches to return, from 1 through 100. | 20 | +| `after` | *Optional[str]* | :heavy_minus_sign: | Batch id from the previous page's `last_id`. | batch_7a4b02 | +| `status` | List[[components.BatchListStatus](../../components/batchliststatus.mdx)] | :heavy_minus_sign: | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | +| `created_after` | [Optional[components.BatchListTimestamp]](../../components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | +| `created_before` | [Optional[components.BatchListTimestamp]](../../components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -214,15 +214,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `endpoint` | [components.Endpoint](../../components/endpoint.mdx) | ✅ | N/A | | -| `model` | *str* | ✅ | N/A | | -| `requests` | List[[components.Request](../../components/request.mdx)] | ✅ | N/A | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `completion_window` | [Optional[components.BatchSubmitBodyCompletionWindow]](../../components/batchsubmitbodycompletionwindow.mdx) | ➖ | N/A | | -| `provider` | [OptionalNullable[components.BatchProviderPreferences]](../../components/batchproviderpreferences.mdx) | ➖ | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `endpoint` | [components.Endpoint](../../components/endpoint.mdx) | :heavy_check_mark: | N/A | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `requests` | List[[components.Request](../../components/request.mdx)] | :heavy_check_mark: | N/A | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `completion_window` | [Optional[components.BatchSubmitBodyCompletionWindow]](../../components/batchsubmitbodycompletionwindow.mdx) | :heavy_minus_sign: | N/A | | +| `provider` | [OptionalNullable[components.BatchProviderPreferences]](../../components/batchproviderpreferences.mdx) | :heavy_minus_sign: | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -265,11 +265,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The batch job id returned from submit. | batch_abc123 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -312,11 +312,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The batch job id returned from submit. | batch_abc123 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/benchmarks/README.mdx b/docs/sdks/benchmarks/README.mdx index 46fe09f0c..5026ac2a2 100644 --- a/docs/sdks/benchmarks/README.mdx +++ b/docs/sdks/benchmarks/README.mdx @@ -40,19 +40,19 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `source` | [Optional[operations.Source]](../../operations/source.mdx) | ➖ | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | -| `task_type` | [Optional[operations.TaskType]](../../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 | -| `benchmark_type` | [Optional[operations.BenchmarkType]](../../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 | -| `include_run_config` | *Optional[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 | -| `search_engine` | *Optional[str]* | ➖ | OpenRouter search benchmarks only: filter by the search engine used. | exa | -| `search_surface` | [Optional[operations.SearchSurface]](../../operations/searchsurface.mdx) | ➖ | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | -| `arena` | [Optional[operations.Arena]](../../operations/arena.mdx) | ➖ | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | -| `category` | *Optional[str]* | ➖ | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | -| `max_results` | *Optional[int]* | ➖ | Maximum number of items to return. When omitted, all matching results are returned. | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `source` | [Optional[operations.Source]](../../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 | +| `task_type` | [Optional[operations.TaskType]](../../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 | +| `benchmark_type` | [Optional[operations.BenchmarkType]](../../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 | +| `include_run_config` | *Optional[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 | +| `search_engine` | *Optional[str]* | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the search engine used. | exa | +| `search_surface` | [Optional[operations.SearchSurface]](../../operations/searchsurface.mdx) | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | +| `arena` | [Optional[operations.Arena]](../../operations/arena.mdx) | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | +| `category` | *Optional[str]* | :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 | +| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of items to return. When omitted, all matching results are returned. | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/betaresponses/README.mdx b/docs/sdks/betaresponses/README.mdx index d0422a491..d9ec09c27 100644 --- a/docs/sdks/betaresponses/README.mdx +++ b/docs/sdks/betaresponses/README.mdx @@ -64,50 +64,50 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | -| `background` | *OptionalNullable[bool]* | ➖ | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | ➖ | N/A | | -| `input` | [Optional[components.InputsUnion]](../../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[str]* | ➖ | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | ➖ | 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` | Dict[str, *str*] | ➖ | 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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | ➖ | N/A | | -| `models` | List[*str*] | ➖ | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | ➖ | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | | -| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | ➖ | 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 | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | -| `session_id` | *Optional[str]* | ➖ | 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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | N/A | | -| `temperature` | *OptionalNullable[float]* | ➖ | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | ➖ | N/A | | -| `top_k` | *Optional[int]* | ➖ | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | ➖ | N/A | | -| `top_p` | *OptionalNullable[float]* | ➖ | N/A | | -| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | ➖ | N/A | auto | -| `user` | *Optional[str]* | ➖ | 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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | +| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | +| `input` | [Optional[components.InputsUnion]](../../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[str]* | :heavy_minus_sign: | N/A | | +| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | :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` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `models` | List[*str*] | :heavy_minus_sign: | N/A | | +| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | :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 | +| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | +| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | +| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | +| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | +| `user` | *Optional[str]* | :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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/byok/README.mdx b/docs/sdks/byok/README.mdx index 83fbd3592..d159c8b23 100644 --- a/docs/sdks/byok/README.mdx +++ b/docs/sdks/byok/README.mdx @@ -46,14 +46,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | ➖ | 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` | [Optional[operations.Provider]](../../operations/provider.mdx) | ➖ | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | :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` | [Optional[operations.Provider]](../../operations/provider.mdx) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -97,23 +97,23 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `key` | *str* | ✅ | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | -| `provider` | [components.BYOKProviderSlug](../../components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_api_key_hashes` | List[*str*] | ➖ | 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"
] | -| `allowed_models` | List[*str*] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declared_region` | [OptionalNullable[components.CreateBYOKKeyRequestDeclaredRegion]](../../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 | -| `declared_zdr` | *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` | *Optional[bool]* | ➖ | Whether this credential should be created in a disabled state. | false | -| `is_byok_only` | *Optional[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 | -| `is_fallback` | *Optional[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 | -| `is_required` | *Optional[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 | -| `name` | *OptionalNullable[str]* | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | -| `workspace_id` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `key` | *str* | :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... | +| `provider` | [components.BYOKProviderSlug](../../components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `allowed_api_key_hashes` | List[*str*] | :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"
] | +| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declared_region` | [OptionalNullable[components.CreateBYOKKeyRequestDeclaredRegion]](../../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 | +| `declared_zdr` | *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | +| `is_byok_only` | *Optional[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 | +| `is_fallback` | *Optional[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 | +| `is_required` | *Optional[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 | +| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | +| `workspace_id` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -158,11 +158,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -206,11 +206,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -254,22 +254,22 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_api_key_hashes` | List[*str*] | ➖ | 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"
] | -| `allowed_models` | List[*str*] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declared_region` | [OptionalNullable[components.UpdateBYOKKeyRequestDeclaredRegion]](../../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 | -| `declared_zdr` | *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` | *Optional[bool]* | ➖ | Whether this credential is disabled. | false | -| `is_byok_only` | *Optional[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 | -| `is_fallback` | *Optional[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 | -| `is_required` | *Optional[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` | *Optional[str]* | ➖ | 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[str]* | ➖ | Optional human-readable name for the credential. | Updated OpenAI Key | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `allowed_api_key_hashes` | List[*str*] | :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"
] | +| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declared_region` | [OptionalNullable[components.UpdateBYOKKeyRequestDeclaredRegion]](../../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 | +| `declared_zdr` | *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential is disabled. | false | +| `is_byok_only` | *Optional[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 | +| `is_fallback` | *Optional[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 | +| `is_required` | *Optional[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` | *Optional[str]* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/chat/README.mdx b/docs/sdks/chat/README.mdx index 83fc358f2..4179eb9de 100644 --- a/docs/sdks/chat/README.mdx +++ b/docs/sdks/chat/README.mdx @@ -79,53 +79,53 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `messages` | List[[components.ChatMessages](../../components/chatmessages.mdx)] | ✅ | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | ➖ | Frequency penalty (-2.0 to 2.0) | 0 | -| `image_config` | Dict[str, [components.ImageConfig](../../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"
} | -| `logit_bias` | Dict[str, *float*] | ➖ | Token logit bias adjustments | \{
"50256": -100
} | -| `logprobs` | *OptionalNullable[bool]* | ➖ | Return log probabilities | false | -| `max_completion_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens in completion | 100 | -| `max_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `metadata` | Dict[str, *str*] | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | -| `min_p` | *OptionalNullable[float]* | ➖ | 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` | List[[components.Modality](../../components/modality.mdx)] | ➖ | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *Optional[str]* | ➖ | Model to use for completion | openai/gpt-4 | -| `models` | List[*str*] | ➖ | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../../components/chatrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | -| `prediction` | [OptionalNullable[components.Prediction]](../../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"
} | -| `presence_penalty` | *OptionalNullable[float]* | ➖ | Presence penalty (-2.0 to 2.0) | 0 | -| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [Optional[components.ChatRequestReasoning]](../../components/chatrequestreasoning.mdx) | ➖ | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../../components/chatrequestreasoningeffort.mdx) | ➖ | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | -| `repetition_penalty` | *OptionalNullable[float]* | ➖ | 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 | -| `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.mdx) | ➖ | Response format configuration | \{
"type": "json_object"
} | -| `seed` | *OptionalNullable[int]* | ➖ | Random seed for deterministic outputs | 42 | -| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../../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 | -| `session_id` | *Optional[str]* | ➖ | 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[components.Stop]](../../components/stop.mdx) | ➖ | Stop sequences (up to 4) | [
"\n"
] | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | Enable streaming response | false | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.mdx) | ➖ | Streaming configuration options | \{
"include_usage": true
} | -| `temperature` | *OptionalNullable[float]* | ➖ | Sampling temperature (0-2) | 0.7 | -| `tool_choice` | [Optional[components.ChatToolChoice]](../../components/chattoolchoice.mdx) | ➖ | Tool choice configuration | auto | -| `tools` | List[[components.ChatFunctionTool](../../components/chatfunctiontool.mdx)] | ➖ | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | -| `top_a` | *OptionalNullable[float]* | ➖ | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | -| `top_k` | *OptionalNullable[int]* | ➖ | 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 | -| `top_logprobs` | *OptionalNullable[int]* | ➖ | Number of top log probabilities to return (0-20) | 5 | -| `top_p` | *OptionalNullable[float]* | ➖ | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `messages` | List[[components.ChatMessages](../../components/chatmessages.mdx)] | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | +| `image_config` | Dict[str, [components.ImageConfig](../../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"
} | +| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | +| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | +| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | +| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | +| `metadata` | Dict[str, *str*] | :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"
} | +| `min_p` | *OptionalNullable[float]* | :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` | List[[components.Modality](../../components/modality.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | +| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | +| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../../components/chatrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `prediction` | [OptionalNullable[components.Prediction]](../../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"
} | +| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | +| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [Optional[components.ChatRequestReasoning]](../../components/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../../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 | +| `repetition_penalty` | *OptionalNullable[float]* | :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 | +| `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.mdx) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | +| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | +| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../../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 | +| `session_id` | *Optional[str]* | :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[components.Stop]](../../components/stop.mdx) | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | +| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.mdx) | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | +| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | +| `tool_choice` | [Optional[components.ChatToolChoice]](../../components/chattoolchoice.mdx) | :heavy_minus_sign: | Tool choice configuration | auto | +| `tools` | List[[components.ChatFunctionTool](../../components/chatfunctiontool.mdx)] | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `top_a` | *OptionalNullable[float]* | :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 | +| `top_k` | *OptionalNullable[int]* | :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 | +| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | +| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | +| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/classifications/README.mdx b/docs/sdks/classifications/README.mdx index c59bcbd8e..bed5f74e5 100644 --- a/docs/sdks/classifications/README.mdx +++ b/docs/sdks/classifications/README.mdx @@ -58,11 +58,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `window` | [Optional[operations.Window]](../../operations/window.mdx) | ➖ | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `window` | [Optional[operations.Window]](../../operations/window.mdx) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/containers/README.mdx b/docs/sdks/containers/README.mdx index 4892ff786..6c21ea543 100644 --- a/docs/sdks/containers/README.mdx +++ b/docs/sdks/containers/README.mdx @@ -43,13 +43,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | ✅ | 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 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | -| `after` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `container_id` | *str* | :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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | +| `after` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -96,12 +96,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | ✅ | 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 | -| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `container_id` | *str* | :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 | +| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -149,12 +149,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | ✅ | 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 | -| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `container_id` | *str* | :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 | +| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -202,12 +202,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | ✅ | 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 | -| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `container_id` | *str* | :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 | +| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/credits/README.mdx b/docs/sdks/credits/README.mdx index 0af3b3eb8..414ae2830 100644 --- a/docs/sdks/credits/README.mdx +++ b/docs/sdks/credits/README.mdx @@ -40,10 +40,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/datasets/README.mdx b/docs/sdks/datasets/README.mdx index d7053e23a..fe31c0f4f 100644 --- a/docs/sdks/datasets/README.mdx +++ b/docs/sdks/datasets/README.mdx @@ -68,17 +68,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `category` | [Optional[operations.GetAppRankingsCategory]](../../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` | [Optional[operations.Subcategory]](../../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` | [Optional[operations.GetAppRankingsSort]](../../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 | -| `start_date` | *Optional[str]* | ➖ | 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 | -| `end_date` | *Optional[str]* | ➖ | 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` | *Optional[int]* | ➖ | Maximum number of apps to return (1-100). Defaults to 50. | 50 | -| `offset` | *OptionalNullable[int]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `category` | [Optional[operations.GetAppRankingsCategory]](../../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` | [Optional[operations.Subcategory]](../../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` | [Optional[operations.GetAppRankingsSort]](../../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 | +| `start_date` | *Optional[str]* | :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 | +| `end_date` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Maximum number of apps to return (1-100). Defaults to 50. | 50 | +| `offset` | *OptionalNullable[int]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -150,17 +150,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `start_date` | *Optional[str]* | ➖ | 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 | -| `end_date` | *Optional[str]* | ➖ | 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` | [Optional[operations.Period]](../../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` | [Optional[operations.Modality]](../../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 | -| `context_bucket` | [Optional[operations.ContextBucket]](../../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` | [Optional[operations.GetRankingsDailyCategory]](../../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 | -| `language_type` | [Optional[operations.LanguageType]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `start_date` | *Optional[str]* | :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 | +| `end_date` | *Optional[str]* | :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` | [Optional[operations.Period]](../../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` | [Optional[operations.Modality]](../../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 | +| `context_bucket` | [Optional[operations.ContextBucket]](../../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` | [Optional[operations.GetRankingsDailyCategory]](../../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 | +| `language_type` | [Optional[operations.LanguageType]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -215,15 +215,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `app_slug` | *Optional[str]* | ➖ | Filter to one published harness slug. | hermes-agent | -| `model` | *Optional[str]* | ➖ | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | -| `turn_range` | [Optional[operations.TurnRange]](../../operations/turnrange.mdx) | ➖ | Filter by the inclusive number of turns in a session. | 10-49-turns | -| `limit` | *Optional[int]* | ➖ | Maximum number of cells to return (1-500). Defaults to 100. | 100 | -| `offset` | *OptionalNullable[int]* | ➖ | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `app_slug` | *Optional[str]* | :heavy_minus_sign: | Filter to one published harness slug. | hermes-agent | +| `model` | *Optional[str]* | :heavy_minus_sign: | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | +| `turn_range` | [Optional[operations.TurnRange]](../../operations/turnrange.mdx) | :heavy_minus_sign: | Filter by the inclusive number of turns in a session. | 10-49-turns | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of cells to return (1-500). Defaults to 100. | 100 | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/decisions/README.mdx b/docs/sdks/decisions/README.mdx index 10f96fd4b..0d2c73720 100644 --- a/docs/sdks/decisions/README.mdx +++ b/docs/sdks/decisions/README.mdx @@ -70,18 +70,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *str* | ✅ | N/A | | -| `questions` | Dict[str, [components.Questions](../../components/questions.mdx)] | ✅ | N/A | | -| `state` | [components.State](../../components/state.mdx) | ✅ | The content to evaluate: a plain string, or a JSON object or array of related context. | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | ➖ | 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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | N/A | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | -| `server_url` | *Optional[str]* | ➖ | An optional server URL to use. | http://localhost:8080 | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `questions` | Dict[str, [components.Questions](../../components/questions.mdx)] | :heavy_check_mark: | N/A | | +| `state` | [components.State](../../components/state.mdx) | :heavy_check_mark: | The content to evaluate: a plain string, or a JSON object or array of related context. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | :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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | ### Response diff --git a/docs/sdks/embeddings/README.mdx b/docs/sdks/embeddings/README.mdx index dfae39541..08cfd727d 100644 --- a/docs/sdks/embeddings/README.mdx +++ b/docs/sdks/embeddings/README.mdx @@ -41,19 +41,19 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `input` | [operations.InputUnion](../../operations/inputunion.mdx) | ✅ | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `model` | *str* | ✅ | The model to use for embeddings | openai/text-embedding-3-small | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `dimensions` | *Optional[int]* | ➖ | The number of dimensions for the output embeddings | 1536 | -| `encoding_format` | [Optional[operations.EncodingFormat]](../../operations/encodingformat.mdx) | ➖ | The format of the output embeddings | float | -| `input_type` | *Optional[str]* | ➖ | The type of input (e.g. search_query, search_document) | search_query | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | ➖ | 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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | A unique identifier for the end-user | user-1234 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `input` | [operations.InputUnion](../../operations/inputunion.mdx) | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | +| `model` | *str* | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `dimensions` | *Optional[int]* | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | +| `encoding_format` | [Optional[operations.EncodingFormat]](../../operations/encodingformat.mdx) | :heavy_minus_sign: | The format of the output embeddings | float | +| `input_type` | *Optional[str]* | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | :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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -110,12 +110,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/endpoints/README.mdx b/docs/sdks/endpoints/README.mdx index bfe6c422f..f8cebc206 100644 --- a/docs/sdks/endpoints/README.mdx +++ b/docs/sdks/endpoints/README.mdx @@ -41,10 +41,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -87,12 +87,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `author` | *str* | ✅ | The author/organization of the model | openai | -| `slug` | *str* | ✅ | The model slug | gpt-4 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | +| `slug` | *str* | :heavy_check_mark: | The model slug | gpt-4 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/endusers/README.mdx b/docs/sdks/endusers/README.mdx index c9513be85..a586a1d47 100644 --- a/docs/sdks/endusers/README.mdx +++ b/docs/sdks/endusers/README.mdx @@ -46,14 +46,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `user` | *Optional[str]* | ➖ | 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 | -| `include_inactive` | *Optional[bool]* | ➖ | Include deactivated registrations. | false | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `user` | *Optional[str]* | :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 | +| `include_inactive` | *Optional[bool]* | :heavy_minus_sign: | Include deactivated registrations. | false | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -98,11 +98,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | ✅ | 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 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `user` | *str* | :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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -147,11 +147,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | ✅ | 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 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `user` | *str* | :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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Errors @@ -192,11 +192,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | ✅ | 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 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `user` | *str* | :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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -241,12 +241,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | ✅ | 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 | -| `is_active` | *bool* | ✅ | Registration state only; does not enforce inference access. | true | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `user` | *str* | :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 | +| `is_active` | *bool* | :heavy_check_mark: | Registration state only; does not enforce inference access. | true | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/files/README.mdx b/docs/sdks/files/README.mdx index 061e84552..d9aef34c1 100644 --- a/docs/sdks/files/README.mdx +++ b/docs/sdks/files/README.mdx @@ -46,18 +46,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Maximum number of files to return (1–1000). | 100 | -| `cursor` | *Optional[str]* | ➖ | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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` | *Optional[str]* | ➖ | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `after_id` | *Optional[str]* | ➖ | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `before_id` | *Optional[str]* | ➖ | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `order` | [Optional[operations.Order]](../../operations/order.mdx) | ➖ | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of files to return (1–1000). | 100 | +| `cursor` | *Optional[str]* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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` | *Optional[str]* | :heavy_minus_sign: | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `after_id` | *Optional[str]* | :heavy_minus_sign: | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `before_id` | *Optional[str]* | :heavy_minus_sign: | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `order` | [Optional[operations.Order]](../../operations/order.mdx) | :heavy_minus_sign: | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -108,13 +108,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file` | [operations.UploadFileFile](../../operations/uploadfilefile.mdx) | ✅ | N/A | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `file` | [operations.UploadFileFile](../../operations/uploadfilefile.mdx) | :heavy_check_mark: | N/A | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -163,13 +163,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -217,13 +217,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -271,13 +271,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/generations/README.mdx b/docs/sdks/generations/README.mdx index 65c5e926d..bc1a56cbb 100644 --- a/docs/sdks/generations/README.mdx +++ b/docs/sdks/generations/README.mdx @@ -42,11 +42,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The generation ID | gen-1234567890 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -96,11 +96,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The generation ID | gen-1234567890 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -150,13 +150,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `category` | [components.SubmitGenerationFeedbackRequestCategory](../../components/submitgenerationfeedbackrequestcategory.mdx) | ✅ | The category of feedback being reported | incorrect_response | -| `generation_id` | *str* | ✅ | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `comment` | *Optional[str]* | ➖ | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `category` | [components.SubmitGenerationFeedbackRequestCategory](../../components/submitgenerationfeedbackrequestcategory.mdx) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | +| `generation_id` | *str* | :heavy_check_mark: | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `comment` | *Optional[str]* | :heavy_minus_sign: | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/guardrails/README.mdx b/docs/sdks/guardrails/README.mdx index 1ad836577..6fbf9985e 100644 --- a/docs/sdks/guardrails/README.mdx +++ b/docs/sdks/guardrails/README.mdx @@ -54,13 +54,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | ➖ | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -110,32 +110,33 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | ✅ | Name for the new guardrail | My New Guardrail | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../../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"
] | -| `allowed_models` | List[*str*] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `allowed_providers` | List[*str*] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../../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[str]* | ➖ | Description of the guardrail | A guardrail for limiting API usage | -| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | -| `enforce_zdr` | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `ignored_models` | List[*str*] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *OptionalNullable[float]* | ➖ | 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 | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `workspace_id` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | true | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../../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"
] | +| `allowed_models` | List[*str*] | :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"
] | +| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../../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[str]* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | +| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | +| `enforce_zdr` | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *OptionalNullable[float]* | :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 | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../../components/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `workspace_id` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -180,11 +181,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -228,11 +229,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -276,32 +277,33 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../../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"
] | -| `allowed_models` | List[*str*] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `allowed_providers` | List[*str*] | ➖ | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../../components/contentfilterentry.mdx)] | ➖ | Custom regex content filters to apply. Set to null to remove. | null | -| `description` | *OptionalNullable[str]* | ➖ | New description for the guardrail | Updated description | -| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | -| `enforce_zdr` | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | -| `ignored_models` | List[*str*] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *OptionalNullable[float]* | ➖ | New spending limit in USD | 75 | -| `name` | *Optional[str]* | ➖ | New name for the guardrail | Updated Guardrail Name | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | false | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../../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"
] | +| `allowed_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | +| `allowed_providers` | List[*str*] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../../components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the guardrail | Updated description | +| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | +| `enforce_zdr` | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | +| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit in USD | 75 | +| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../../components/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -350,13 +352,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -402,12 +404,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hashes` | List[*str*] | ✅ | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -455,12 +457,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hashes` | List[*str*] | ✅ | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -507,13 +509,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -560,12 +562,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `member_user_ids` | List[*str*] | ✅ | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -613,12 +615,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `member_user_ids` | List[*str*] | ✅ | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -665,12 +667,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -715,12 +717,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/images/README.mdx b/docs/sdks/images/README.mdx index 8cb4e9e20..08c687694 100644 --- a/docs/sdks/images/README.mdx +++ b/docs/sdks/images/README.mdx @@ -44,27 +44,27 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `model` | *str* | ✅ | The image generation model to use | bytedance-seed/seedream-4.5 | -| `prompt` | *str* | ✅ | Text description of the desired image | a red panda astronaut floating in space, studio lighting | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `aspect_ratio` | [Optional[components.ImageGenerationRequestAspectRatio]](../../components/imagegenerationrequestaspectratio.mdx) | ➖ | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | -| `background` | [Optional[components.ImageGenerationRequestBackground]](../../components/imagegenerationrequestbackground.mdx) | ➖ | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | -| `input_references` | List[[components.ContentPartImage](../../components/contentpartimage.mdx)] | ➖ | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | -| `n` | *Optional[int]* | ➖ | 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 | -| `output_compression` | *Optional[int]* | ➖ | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | -| `output_format` | [Optional[components.ImageGenerationRequestOutputFormat]](../../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 | -| `provider` | [Optional[components.ImageGenerationProviderPreferences]](../../components/imagegenerationproviderpreferences.mdx) | ➖ | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | -| `quality` | [Optional[components.ImageGenerationRequestQuality]](../../components/imagegenerationrequestquality.mdx) | ➖ | Rendering quality. Providers without a quality knob ignore this. | high | -| `resolution` | [Optional[components.ImageGenerationRequestResolution]](../../components/imagegenerationrequestresolution.mdx) | ➖ | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | -| `seed` | *Optional[int]* | ➖ | 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. | | -| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | *Optional[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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `model` | *str* | :heavy_check_mark: | The image generation model to use | bytedance-seed/seedream-4.5 | +| `prompt` | *str* | :heavy_check_mark: | Text description of the desired image | a red panda astronaut floating in space, studio lighting | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `aspect_ratio` | [Optional[components.ImageGenerationRequestAspectRatio]](../../components/imagegenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | +| `background` | [Optional[components.ImageGenerationRequestBackground]](../../components/imagegenerationrequestbackground.mdx) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | +| `input_references` | List[[components.ContentPartImage](../../components/contentpartimage.mdx)] | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | +| `n` | *Optional[int]* | :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 | +| `output_compression` | *Optional[int]* | :heavy_minus_sign: | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | +| `output_format` | [Optional[components.ImageGenerationRequestOutputFormat]](../../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 | +| `provider` | [Optional[components.ImageGenerationProviderPreferences]](../../components/imagegenerationproviderpreferences.mdx) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | +| `quality` | [Optional[components.ImageGenerationRequestQuality]](../../components/imagegenerationrequestquality.mdx) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | +| `resolution` | [Optional[components.ImageGenerationRequestResolution]](../../components/imagegenerationrequestresolution.mdx) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | +| `seed` | *Optional[int]* | :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. | | +| `session_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | *Optional[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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -116,10 +116,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -161,12 +161,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `author` | *str* | ✅ | Model author/organization | bytedance-seed | -| `slug` | *str* | ✅ | Model slug | seedream-4.5 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `author` | *str* | :heavy_check_mark: | Model author/organization | bytedance-seed | +| `slug` | *str* | :heavy_check_mark: | Model slug | seedream-4.5 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/interns/README.mdx b/docs/sdks/interns/README.mdx index a7bd746bb..b90fc698b 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 * [get_intern](#get_intern) - Get an intern * [update_intern](#update_intern) - Update an intern * [get_intern_daemon](#get_intern_daemon) - Get an intern's daemon access -* [~~get_intern_daemon_access~~](#get_intern_daemon_access) - Get an intern's daemon access (deprecated alias) ⚠️ **Deprecated** -* [~~sign_intern_daemon_access_request~~](#sign_intern_daemon_access_request) - Sign a daemon request with the caller's identity (deprecated alias) ⚠️ **Deprecated** +* [~~get_intern_daemon_access~~](#get_intern_daemon_access) - Get an intern's daemon access (deprecated alias) :warning: **Deprecated** +* [~~sign_intern_daemon_access_request~~](#sign_intern_daemon_access_request) - Sign a daemon request with the caller's identity (deprecated alias) :warning: **Deprecated** * [sign_intern_daemon_request](#sign_intern_daemon_request) - Sign a daemon request with the caller's identity * [provision_intern](#provision_intern) - Provision an intern * [suspend_intern](#suspend_intern) - Suspend an intern @@ -52,14 +52,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Maximum number of interns to return, from 1 through 500. | 50 | -| `status` | List[[operations.Status](../../operations/status.mdx)] | ➖ | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | -| `starting_after` | *Optional[str]* | ➖ | 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 | -| `workspace_id` | *Optional[str]* | ➖ | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of interns to return, from 1 through 500. | 50 | +| `status` | List[[operations.Status](../../operations/status.mdx)] | :heavy_minus_sign: | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | +| `starting_after` | *Optional[str]* | :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 | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -102,17 +102,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | ✅ | Intern name, unique per creator within the workspace. | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotency_key` | *Optional[str]* | ➖ | 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 | -| `description` | *OptionalNullable[str]* | ➖ | Free-form description, or null. | | -| `instructions` | *OptionalNullable[str]* | ➖ | Standing instructions the intern boots with, or null. | | -| `provision` | *Optional[bool]* | ➖ | Start provisioning during this create operation. Defaults to false. | | -| `vault_id` | *Optional[str]* | ➖ | Vault owned by another intern in this workspace to attach as a borrowed vault. | | -| `workspace_id` | *Optional[str]* | ➖ | Workspace that will own the intern. Defaults to the workspace the API key resolves to. When given, it must match the API key workspace. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | :heavy_check_mark: | Intern name, unique per creator within the workspace. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotency_key` | *Optional[str]* | :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 | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Free-form description, or null. | | +| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | Standing instructions the intern boots with, or null. | | +| `provision` | *Optional[bool]* | :heavy_minus_sign: | Start provisioning during this create operation. Defaults to false. | | +| `vault_id` | *Optional[str]* | :heavy_minus_sign: | Vault owned by another intern in this workspace to attach as a borrowed vault. | | +| `workspace_id` | *Optional[str]* | :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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -155,12 +155,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `acknowledge_workspace_loss` | *Optional[bool]* | ➖ | Delete even though the workspace backup was not confirmed. Defaults to false, which refuses the teardown when a workspace archive is missing. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `acknowledge_workspace_loss` | *Optional[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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -203,11 +203,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -250,15 +250,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `description` | *OptionalNullable[str]* | ➖ | New free-form description. Null clears it. | | -| `instructions` | *OptionalNullable[str]* | ➖ | New standing instructions. Null clears them. | | -| `model` | *OptionalNullable[str]* | ➖ | 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` | *Optional[str]* | ➖ | New intern name, unique per creator within the workspace. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New free-form description. Null clears it. | | +| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | New standing instructions. Null clears them. | | +| `model` | *OptionalNullable[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | New intern name, unique per creator within the workspace. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -301,11 +301,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -323,7 +323,7 @@ with OpenRouter( 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 @@ -350,11 +350,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -372,7 +372,7 @@ with OpenRouter( 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 @@ -399,12 +399,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `body_sha256` | *str* | ✅ | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `body_sha256` | *str* | :heavy_check_mark: | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -448,12 +448,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `body_sha256` | *str* | ✅ | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `body_sha256` | *str* | :heavy_check_mark: | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -497,11 +497,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -544,11 +544,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -610,15 +610,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | -| `messages` | List[[components.InternChatMessage](../../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`. | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `approval_mode` | [Optional[components.InternApprovalMode]](../../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 | -| `model` | *Optional[str]* | ➖ | 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 | -| `session_id` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | +| `messages` | List[[components.InternChatMessage](../../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`. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `approval_mode` | [Optional[components.InternApprovalMode]](../../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 | +| `model` | *Optional[str]* | :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 | +| `session_id` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -669,13 +669,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | The intern to run. | a11e0000-0000-4000-8000-000000000005 | -| `input` | *str* | ✅ | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `session_id` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | The intern to run. | a11e0000-0000-4000-8000-000000000005 | +| `input` | *str* | :heavy_check_mark: | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `session_id` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/models/README.mdx b/docs/sdks/models/README.mdx index ad099b012..9131aee97 100644 --- a/docs/sdks/models/README.mdx +++ b/docs/sdks/models/README.mdx @@ -43,12 +43,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `author` | *str* | ✅ | The author/organization of the model | openai | -| `slug` | *str* | ✅ | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | +| `slug` | *str* | :heavy_check_mark: | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -94,39 +94,39 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `category` | [Optional[operations.GetModelsCategory]](../../operations/getmodelscategory.mdx) | ➖ | Filter models by use case category | programming | -| `supported_parameters` | *Optional[str]* | ➖ | Filter models by supported parameter (comma-separated) | temperature | -| `output_modalities` | *Optional[str]* | ➖ | 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` | [Optional[operations.GetModelsSort]](../../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` | *Optional[str]* | ➖ | Free-text search by model name or slug. | gpt-4 | -| `input_modalities` | *Optional[str]* | ➖ | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | -| `context` | *Optional[int]* | ➖ | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | -| `min_price` | *OptionalNullable[float]* | ➖ | Minimum prompt price in $/M tokens. | 0 | -| `max_price` | *OptionalNullable[float]* | ➖ | Maximum prompt price in $/M tokens. | 10 | -| `arch` | *Optional[str]* | ➖ | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | -| `model_authors` | *Optional[str]* | ➖ | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | -| `providers` | *Optional[str]* | ➖ | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | -| `distillable` | [Optional[operations.Distillable]](../../operations/distillable.mdx) | ➖ | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | -| `zdr` | [Optional[operations.Zdr]](../../operations/zdr.mdx) | ➖ | When set to "true", return only models with zero data retention endpoints. | true | -| `region` | [Optional[operations.Region]](../../operations/region.mdx) | ➖ | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | -| `min_output_price` | *OptionalNullable[float]* | ➖ | Minimum completion (output) price in $/M tokens. | 0 | -| `max_output_price` | *OptionalNullable[float]* | ➖ | Maximum completion (output) price in $/M tokens. | 10 | -| `min_age_days` | *OptionalNullable[int]* | ➖ | Minimum model age in days since its creation date. | 0 | -| `max_age_days` | *OptionalNullable[int]* | ➖ | Maximum model age in days since its creation date. | 90 | -| `min_intelligence_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis intelligence index. | 50 | -| `max_intelligence_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis intelligence index. | 100 | -| `min_coding_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis coding index. | 50 | -| `max_coding_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis coding index. | 100 | -| `min_agentic_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis agentic index. | 50 | -| `max_agentic_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis agentic index. | 100 | -| `min_tool_success_rate` | *OptionalNullable[float]* | ➖ | 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 | -| `max_tool_success_rate` | *OptionalNullable[float]* | ➖ | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | :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` | [Optional[operations.GetModelsCategory]](../../operations/getmodelscategory.mdx) | :heavy_minus_sign: | Filter models by use case category | programming | +| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | +| `output_modalities` | *Optional[str]* | :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` | [Optional[operations.GetModelsSort]](../../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` | *Optional[str]* | :heavy_minus_sign: | Free-text search by model name or slug. | gpt-4 | +| `input_modalities` | *Optional[str]* | :heavy_minus_sign: | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | +| `context` | *Optional[int]* | :heavy_minus_sign: | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | +| `min_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum prompt price in $/M tokens. | 0 | +| `max_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum prompt price in $/M tokens. | 10 | +| `arch` | *Optional[str]* | :heavy_minus_sign: | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | +| `model_authors` | *Optional[str]* | :heavy_minus_sign: | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | +| `providers` | *Optional[str]* | :heavy_minus_sign: | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | +| `distillable` | [Optional[operations.Distillable]](../../operations/distillable.mdx) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | +| `zdr` | [Optional[operations.Zdr]](../../operations/zdr.mdx) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | +| `region` | [Optional[operations.Region]](../../operations/region.mdx) | :heavy_minus_sign: | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | +| `min_output_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum completion (output) price in $/M tokens. | 0 | +| `max_output_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum completion (output) price in $/M tokens. | 10 | +| `min_age_days` | *OptionalNullable[int]* | :heavy_minus_sign: | Minimum model age in days since its creation date. | 0 | +| `max_age_days` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum model age in days since its creation date. | 90 | +| `min_intelligence_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis intelligence index. | 50 | +| `max_intelligence_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis intelligence index. | 100 | +| `min_coding_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis coding index. | 50 | +| `max_coding_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis coding index. | 100 | +| `min_agentic_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis agentic index. | 50 | +| `max_agentic_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis agentic index. | 100 | +| `min_tool_success_rate` | *OptionalNullable[float]* | :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 | +| `max_tool_success_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -170,11 +170,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `output_modalities` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `output_modalities` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -221,14 +221,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `security` | [operations.ListModelsUserSecurity](../../operations/listmodelsusersecurity.mdx) | ✅ | N/A | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `output_modalities` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `security` | [operations.ListModelsUserSecurity](../../operations/listmodelsusersecurity.mdx) | :heavy_check_mark: | N/A | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `output_modalities` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/oauth/README.mdx b/docs/sdks/oauth/README.mdx index 50b9f0224..ac1d96c85 100644 --- a/docs/sdks/oauth/README.mdx +++ b/docs/sdks/oauth/README.mdx @@ -43,13 +43,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *str* | ✅ | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../../operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | -| `code_verifier` | *Optional[str]* | ➖ | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `code` | *str* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../../operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | +| `code_verifier` | *Optional[str]* | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -93,18 +93,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `callback_url` | *str* | ✅ | 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 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `code_challenge` | *Optional[str]* | ➖ | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../../operations/createauthkeyscodecodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | 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 | -| `key_label` | *Optional[str]* | ➖ | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | -| `limit` | *Optional[float]* | ➖ | Credit limit for the API key to be created | 100 | -| `usage_limit_type` | [Optional[operations.UsageLimitType]](../../operations/usagelimittype.mdx) | ➖ | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | -| `workspace_id` | *Optional[str]* | ➖ | Optional workspace ID to associate the API key with | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `callback_url` | *str* | :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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `code_challenge` | *Optional[str]* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | +| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../../operations/createauthkeyscodecodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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 | +| `key_label` | *Optional[str]* | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | +| `limit` | *Optional[float]* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | +| `usage_limit_type` | [Optional[operations.UsageLimitType]](../../operations/usagelimittype.mdx) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to associate the API key with | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -150,10 +150,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -195,16 +195,16 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `federation_policy_id` | *str* | ✅ | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | -| `grant_type` | [components.GrantType](../../components/granttype.mdx) | ✅ | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | -| `subject_token` | *str* | ✅ | The JWT issued by your identity provider. | \ | -| `subject_token_type` | [components.SubjectTokenType](../../components/subjecttokentype.mdx) | ✅ | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requested_token_type` | [Optional[components.RequestedTokenType]](../../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` | [Optional[components.TokenExchangeRequestScope]](../../components/tokenexchangerequestscope.mdx) | ➖ | Optional; only `inference` is available. | inference | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `federation_policy_id` | *str* | :heavy_check_mark: | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | +| `grant_type` | [components.GrantType](../../components/granttype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | +| `subject_token` | *str* | :heavy_check_mark: | The JWT issued by your identity provider. | \ | +| `subject_token_type` | [components.SubjectTokenType](../../components/subjecttokentype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `requested_token_type` | [Optional[components.RequestedTokenType]](../../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` | [Optional[components.TokenExchangeRequestScope]](../../components/tokenexchangerequestscope.mdx) | :heavy_minus_sign: | Optional; only `inference` is available. | inference | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/observability/README.mdx b/docs/sdks/observability/README.mdx index ee483a418..b87e2e382 100644 --- a/docs/sdks/observability/README.mdx +++ b/docs/sdks/observability/README.mdx @@ -46,13 +46,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | ➖ | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -100,24 +100,24 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `config` | Dict[str, *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"
} | -| `name` | *str* | ✅ | Human-readable name for the destination. | Production Langfuse | -| `type` | [components.CreateObservabilityDestinationRequestType](../../components/createobservabilitydestinationrequesttype.mdx) | ✅ | The destination type. Only stable destination types are accepted. | langfuse | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `api_key_hashes` | List[*str*] | ➖ | 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 | -| `broadcast_generation_cost` | *Optional[bool]* | ➖ | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *Optional[bool]* | ➖ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *Optional[bool]* | ➖ | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *Optional[bool]* | ➖ | When true, include request-context generation metadata. | false | -| `enabled` | *Optional[bool]* | ➖ | Whether this destination should be enabled immediately. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../../components/observabilityfilterrulesconfignullable.mdx) | ➖ | Optional structured filter rules controlling which events are forwarded. | null | -| `privacy_mode` | *Optional[bool]* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegionInput](../../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"
] | -| `sampling_rate` | *Optional[float]* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `workspace_id` | *Optional[str]* | ➖ | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `config` | Dict[str, *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"
} | +| `name` | *str* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `type` | [components.CreateObservabilityDestinationRequestType](../../components/createobservabilitydestinationrequesttype.mdx) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *Optional[bool]* | :heavy_minus_sign: | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *Optional[bool]* | :heavy_minus_sign: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *Optional[bool]* | :heavy_minus_sign: | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *Optional[bool]* | :heavy_minus_sign: | When true, include request-context generation metadata. | false | +| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | +| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../../components/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | +| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegionInput](../../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"
] | +| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -163,11 +163,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -211,11 +211,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -259,23 +259,23 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `api_key_hashes` | List[*str*] | ➖ | 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 | -| `broadcast_generation_cost` | *Optional[bool]* | ➖ | Whether to include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *Optional[bool]* | ➖ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *Optional[bool]* | ➖ | Whether to include identity generation metadata. | false | -| `broadcast_generation_request_context` | *Optional[bool]* | ➖ | Whether to include request-context generation metadata. | false | -| `config` | Dict[str, *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` | *Optional[bool]* | ➖ | Whether the destination is enabled. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../../components/observabilityfilterrulesconfignullable.mdx) | ➖ | N/A | null | -| `name` | *Optional[str]* | ➖ | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *Optional[bool]* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegionInput](../../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"
] | -| `sampling_rate` | *Optional[float]* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `api_key_hashes` | List[*str*] | :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 | +| `broadcast_generation_cost` | *Optional[bool]* | :heavy_minus_sign: | Whether to include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *Optional[bool]* | :heavy_minus_sign: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *Optional[bool]* | :heavy_minus_sign: | Whether to include identity generation metadata. | false | +| `broadcast_generation_request_context` | *Optional[bool]* | :heavy_minus_sign: | Whether to include request-context generation metadata. | false | +| `config` | Dict[str, *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` | *Optional[bool]* | :heavy_minus_sign: | Whether the destination is enabled. | true | +| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../../components/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | N/A | null | +| `name` | *Optional[str]* | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegionInput](../../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"
] | +| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/organization/README.mdx b/docs/sdks/organization/README.mdx index 6ab988db6..c39c54c9f 100644 --- a/docs/sdks/organization/README.mdx +++ b/docs/sdks/organization/README.mdx @@ -44,12 +44,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -93,10 +93,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -140,11 +140,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is_filtered_model_catalog_enabled` | *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 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `is_filtered_model_catalog_enabled` | *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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/presets/README.mdx b/docs/sdks/presets/README.mdx index 9d209f102..a13fecc06 100644 --- a/docs/sdks/presets/README.mdx +++ b/docs/sdks/presets/README.mdx @@ -48,12 +48,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -97,11 +97,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -155,53 +155,53 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messages` | List[[components.ChatMessages](../../components/chatmessages.mdx)] | ✅ | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | ➖ | Frequency penalty (-2.0 to 2.0) | 0 | -| `image_config` | Dict[str, [components.ImageConfig](../../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"
} | -| `logit_bias` | Dict[str, *float*] | ➖ | Token logit bias adjustments | \{
"50256": -100
} | -| `logprobs` | *OptionalNullable[bool]* | ➖ | Return log probabilities | false | -| `max_completion_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens in completion | 100 | -| `max_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `metadata` | Dict[str, *str*] | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | -| `min_p` | *OptionalNullable[float]* | ➖ | 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` | List[[components.Modality](../../components/modality.mdx)] | ➖ | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *Optional[str]* | ➖ | Model to use for completion | openai/gpt-4 | -| `models` | List[*str*] | ➖ | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../../components/chatrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | -| `prediction` | [OptionalNullable[components.Prediction]](../../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"
} | -| `presence_penalty` | *OptionalNullable[float]* | ➖ | Presence penalty (-2.0 to 2.0) | 0 | -| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [Optional[components.ChatRequestReasoning]](../../components/chatrequestreasoning.mdx) | ➖ | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../../components/chatrequestreasoningeffort.mdx) | ➖ | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | -| `repetition_penalty` | *OptionalNullable[float]* | ➖ | 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 | -| `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.mdx) | ➖ | Response format configuration | \{
"type": "json_object"
} | -| `seed` | *OptionalNullable[int]* | ➖ | Random seed for deterministic outputs | 42 | -| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../../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 | -| `session_id` | *Optional[str]* | ➖ | 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[components.Stop]](../../components/stop.mdx) | ➖ | Stop sequences (up to 4) | [
"\n"
] | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | Enable streaming response | false | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.mdx) | ➖ | Streaming configuration options | \{
"include_usage": true
} | -| `temperature` | *OptionalNullable[float]* | ➖ | Sampling temperature (0-2) | 0.7 | -| `tool_choice` | [Optional[components.ChatToolChoice]](../../components/chattoolchoice.mdx) | ➖ | Tool choice configuration | auto | -| `tools` | List[[components.ChatFunctionTool](../../components/chatfunctiontool.mdx)] | ➖ | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | -| `top_a` | *OptionalNullable[float]* | ➖ | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | -| `top_k` | *OptionalNullable[int]* | ➖ | 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 | -| `top_logprobs` | *OptionalNullable[int]* | ➖ | Number of top log probabilities to return (0-20) | 5 | -| `top_p` | *OptionalNullable[float]* | ➖ | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `messages` | List[[components.ChatMessages](../../components/chatmessages.mdx)] | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | +| `image_config` | Dict[str, [components.ImageConfig](../../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"
} | +| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | +| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | +| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | +| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | +| `metadata` | Dict[str, *str*] | :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"
} | +| `min_p` | *OptionalNullable[float]* | :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` | List[[components.Modality](../../components/modality.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | +| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | +| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../../components/chatrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `prediction` | [OptionalNullable[components.Prediction]](../../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"
} | +| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | +| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [Optional[components.ChatRequestReasoning]](../../components/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../../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 | +| `repetition_penalty` | *OptionalNullable[float]* | :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 | +| `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.mdx) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | +| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | +| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../../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 | +| `session_id` | *Optional[str]* | :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[components.Stop]](../../components/stop.mdx) | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | +| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.mdx) | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | +| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | +| `tool_choice` | [Optional[components.ChatToolChoice]](../../components/chattoolchoice.mdx) | :heavy_minus_sign: | Tool choice configuration | auto | +| `tools` | List[[components.ChatFunctionTool](../../components/chatfunctiontool.mdx)] | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `top_a` | *OptionalNullable[float]* | :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 | +| `top_k` | *OptionalNullable[int]* | :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 | +| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | +| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | +| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -253,39 +253,39 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messages` | List[[components.MessagesMessageParam](../../components/messagesmessageparam.mdx)] | ✅ | N/A | | -| `model` | *str* | ✅ | N/A | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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"
} | -| `context_management` | [OptionalNullable[components.ContextManagement]](../../components/contextmanagement.mdx) | ➖ | N/A | | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `fallbacks` | List[[components.MessagesFallbackParam](../../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"
}
] | -| `max_tokens` | *Optional[int]* | ➖ | N/A | | -| `metadata` | [Optional[components.MessagesRequestMetadata]](../../components/messagesrequestmetadata.mdx) | ➖ | N/A | | -| `models` | List[*str*] | ➖ | N/A | | -| `output_config` | [Optional[components.MessagesOutputConfig]](../../components/messagesoutputconfig.mdx) | ➖ | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | -| `plugins` | List[[components.MessagesRequestPlugin](../../components/messagesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `safeguards` | List[[components.AnthropicSafeguard](../../components/anthropicsafeguard.mdx)] | ➖ | N/A | | -| `service_tier` | *Optional[str]* | ➖ | N/A | | -| `session_id` | *Optional[str]* | ➖ | 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[components.Speed]](../../components/speed.mdx) | ➖ | N/A | fast | -| `stop_sequences` | List[*str*] | ➖ | N/A | | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | N/A | | -| `system` | [Optional[components.System]](../../components/system.mdx) | ➖ | N/A | | -| `temperature` | *Optional[float]* | ➖ | N/A | | -| `thinking` | [Optional[components.Thinking]](../../components/thinking.mdx) | ➖ | N/A | | -| `tool_choice` | [Optional[components.ToolChoice]](../../components/toolchoice.mdx) | ➖ | N/A | | -| `tools` | List[[components.MessagesRequestToolUnion](../../components/messagesrequesttoolunion.mdx)] | ➖ | N/A | | -| `top_k` | *Optional[int]* | ➖ | N/A | | -| `top_p` | *Optional[float]* | ➖ | N/A | | -| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `messages` | List[[components.MessagesMessageParam](../../components/messagesmessageparam.mdx)] | :heavy_check_mark: | N/A | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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"
} | +| `context_management` | [OptionalNullable[components.ContextManagement]](../../components/contextmanagement.mdx) | :heavy_minus_sign: | N/A | | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `fallbacks` | List[[components.MessagesFallbackParam](../../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"
}
] | +| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `metadata` | [Optional[components.MessagesRequestMetadata]](../../components/messagesrequestmetadata.mdx) | :heavy_minus_sign: | N/A | | +| `models` | List[*str*] | :heavy_minus_sign: | N/A | | +| `output_config` | [Optional[components.MessagesOutputConfig]](../../components/messagesoutputconfig.mdx) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | +| `plugins` | List[[components.MessagesRequestPlugin](../../components/messagesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `safeguards` | List[[components.AnthropicSafeguard](../../components/anthropicsafeguard.mdx)] | :heavy_minus_sign: | N/A | | +| `service_tier` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `session_id` | *Optional[str]* | :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[components.Speed]](../../components/speed.mdx) | :heavy_minus_sign: | N/A | fast | +| `stop_sequences` | List[*str*] | :heavy_minus_sign: | N/A | | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `system` | [Optional[components.System]](../../components/system.mdx) | :heavy_minus_sign: | N/A | | +| `temperature` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `thinking` | [Optional[components.Thinking]](../../components/thinking.mdx) | :heavy_minus_sign: | N/A | | +| `tool_choice` | [Optional[components.ToolChoice]](../../components/toolchoice.mdx) | :heavy_minus_sign: | N/A | | +| `tools` | List[[components.MessagesRequestToolUnion](../../components/messagesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | +| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `top_p` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -332,50 +332,50 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `background` | *OptionalNullable[bool]* | ➖ | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | ➖ | N/A | | -| `input` | [Optional[components.InputsUnion]](../../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[str]* | ➖ | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | ➖ | 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` | Dict[str, *str*] | ➖ | 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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | ➖ | N/A | | -| `models` | List[*str*] | ➖ | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | ➖ | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | | -| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | ➖ | 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 | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | -| `session_id` | *Optional[str]* | ➖ | 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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | N/A | | -| `temperature` | *OptionalNullable[float]* | ➖ | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | ➖ | N/A | | -| `top_k` | *Optional[int]* | ➖ | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | ➖ | N/A | | -| `top_p` | *OptionalNullable[float]* | ➖ | N/A | | -| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | ➖ | N/A | auto | -| `user` | *Optional[str]* | ➖ | 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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | +| `input` | [Optional[components.InputsUnion]](../../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[str]* | :heavy_minus_sign: | N/A | | +| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | :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` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `models` | List[*str*] | :heavy_minus_sign: | N/A | | +| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | :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 | +| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | +| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | +| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | +| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | +| `user` | *Optional[str]* | :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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -424,13 +424,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -475,12 +475,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | -| `version` | *str* | ✅ | Version number of the preset. | 1 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `version` | *str* | :heavy_check_mark: | Version number of the preset. | 1 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/privateendpoints/README.mdx b/docs/sdks/privateendpoints/README.mdx index c36065eb1..a0cd92faa 100644 --- a/docs/sdks/privateendpoints/README.mdx +++ b/docs/sdks/privateendpoints/README.mdx @@ -49,10 +49,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -97,19 +97,19 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `provider_slug` | *str* | ✅ | Slug of the upstream provider. | azure | -| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotency_key` | *Optional[str]* | ➖ | 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 | -| `activate` | [Optional[components.PrivateEndpointActivation]](../../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"
} | -| `base_url` | *Optional[str]* | ➖ | 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 | -| `declared_region` | [OptionalNullable[components.CreatePrivateEndpointRequestDeclaredRegion]](../../components/createprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | -| `declared_zdr` | *OptionalNullable[bool]* | ➖ | Attest that this deployment retains no prompt or completion data. | | -| `pricing` | [Optional[components.PrivateEndpointPricing]](../../components/privateendpointpricing.mdx) | ➖ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `provider_slug` | *str* | :heavy_check_mark: | Slug of the upstream provider. | azure | +| `upstream_model_id` | *str* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotency_key` | *Optional[str]* | :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 | +| `activate` | [Optional[components.PrivateEndpointActivation]](../../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"
} | +| `base_url` | *Optional[str]* | :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 | +| `declared_region` | [OptionalNullable[components.CreatePrivateEndpointRequestDeclaredRegion]](../../components/createprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | +| `declared_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | +| `pricing` | [Optional[components.PrivateEndpointPricing]](../../components/privateendpointpricing.mdx) | :heavy_minus_sign: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -164,12 +164,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `draft_only` | [Optional[operations.DraftOnly]](../../operations/draftonly.mdx) | ➖ | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `draft_only` | [Optional[operations.DraftOnly]](../../operations/draftonly.mdx) | :heavy_minus_sign: | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -219,11 +219,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -269,15 +269,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `base_url` | *Optional[str]* | ➖ | 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 | -| `declared_region` | [OptionalNullable[components.UpdatePrivateEndpointRequestDeclaredRegion]](../../components/updateprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | -| `declared_zdr` | *OptionalNullable[bool]* | ➖ | Attest that this deployment retains no prompt or completion data. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `upstream_model_id` | *str* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `base_url` | *Optional[str]* | :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 | +| `declared_region` | [OptionalNullable[components.UpdatePrivateEndpointRequestDeclaredRegion]](../../components/updateprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | +| `declared_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -327,11 +327,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -381,11 +381,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -435,11 +435,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -492,12 +492,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `pricing` | [components.PrivateEndpointPricing](../../components/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `pricing` | [components.PrivateEndpointPricing](../../components/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -547,12 +547,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `workspace_id` | *str* | ✅ | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `workspace_id` | *str* | :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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/providers/README.mdx b/docs/sdks/providers/README.mdx index fbd074b61..7571e2581 100644 --- a/docs/sdks/providers/README.mdx +++ b/docs/sdks/providers/README.mdx @@ -40,10 +40,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/rerank/README.mdx b/docs/sdks/rerank/README.mdx index fe71c14df..0836d633a 100644 --- a/docs/sdks/rerank/README.mdx +++ b/docs/sdks/rerank/README.mdx @@ -43,18 +43,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `documents` | List[[operations.Document](../../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` | *str* | ✅ | The rerank model to use | cohere/rerank-v3.5 | -| `query` | *str* | ✅ | The search query to rerank documents against | What is the capital of France? | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | ➖ | 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 | -| `top_n` | *Optional[int]* | ➖ | Number of most relevant documents to return | 3 | -| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `documents` | List[[operations.Document](../../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` | *str* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | +| `query` | *str* | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | :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 | +| `top_n` | *Optional[int]* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | +| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/responses/README.mdx b/docs/sdks/responses/README.mdx index cea72b0cf..ffa211962 100644 --- a/docs/sdks/responses/README.mdx +++ b/docs/sdks/responses/README.mdx @@ -64,50 +64,50 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | -| `background` | *OptionalNullable[bool]* | ➖ | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | ➖ | N/A | | -| `input` | [Optional[components.InputsUnion]](../../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[str]* | ➖ | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | ➖ | 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` | Dict[str, *str*] | ➖ | 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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | ➖ | N/A | | -| `models` | List[*str*] | ➖ | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | ➖ | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | | -| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | ➖ | 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 | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | -| `session_id` | *Optional[str]* | ➖ | 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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | N/A | | -| `temperature` | *OptionalNullable[float]* | ➖ | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | ➖ | N/A | | -| `top_k` | *Optional[int]* | ➖ | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | ➖ | N/A | | -| `top_p` | *OptionalNullable[float]* | ➖ | N/A | | -| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | ➖ | N/A | auto | -| `user` | *Optional[str]* | ➖ | 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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | +| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | +| `input` | [Optional[components.InputsUnion]](../../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[str]* | :heavy_minus_sign: | N/A | | +| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | :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` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `models` | List[*str*] | :heavy_minus_sign: | N/A | | +| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | +| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | :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 | +| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | +| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | +| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | +| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | +| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | +| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | +| `user` | *Optional[str]* | :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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/scim/README.mdx b/docs/sdks/scim/README.mdx index 82b0c6ae7..240f5da9d 100644 --- a/docs/sdks/scim/README.mdx +++ b/docs/sdks/scim/README.mdx @@ -49,12 +49,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -98,13 +98,13 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `role` | [components.CreateScimGroupMappingRequestRole](../../components/createscimgroupmappingrequestrole.mdx) | ✅ | N/A | -| `scim_group_id` | *str* | ✅ | N/A | -| `workspace_id` | *str* | ✅ | N/A | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `role` | [components.CreateScimGroupMappingRequestRole](../../components/createscimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | +| `scim_group_id` | *str* | :heavy_check_mark: | N/A | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -150,12 +150,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | | -| `keep_members` | [operations.KeepMembers](../../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 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `keep_members` | [operations.KeepMembers](../../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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -200,11 +200,11 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `id` | *str* | :heavy_check_mark: | N/A | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -248,12 +248,12 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | -| `role` | [components.UpdateScimGroupMappingRequestRole](../../components/updatescimgroupmappingrequestrole.mdx) | ✅ | N/A | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `id` | *str* | :heavy_check_mark: | N/A | +| `role` | [components.UpdateScimGroupMappingRequestRole](../../components/updatescimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -300,14 +300,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `display_name` | *Optional[str]* | ➖ | 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 | -| `external_id` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `display_name` | *Optional[str]* | :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 | +| `external_id` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -351,10 +351,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response @@ -398,11 +398,11 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | N/A | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `id` | *str* | :heavy_check_mark: | N/A | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/stt/README.mdx b/docs/sdks/stt/README.mdx index ff48aa481..50c67920c 100644 --- a/docs/sdks/stt/README.mdx +++ b/docs/sdks/stt/README.mdx @@ -44,22 +44,22 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `input_audio` | [components.STTInputAudio](../../components/sttinputaudio.mdx) | ✅ | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | -| `model` | *str* | ✅ | STT model identifier | openai/whisper-large-v3 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `diarize` | *Optional[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 | -| `keyterms` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | -| `provider` | [Optional[components.STTRequestProvider]](../../components/sttrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `response_format` | [Optional[components.STTRequestResponseFormat]](../../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 | -| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | Sampling temperature for transcription | 0 | -| `timestamp_granularities` | List[[components.STTTimestampGranularity](../../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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `input_audio` | [components.STTInputAudio](../../components/sttinputaudio.mdx) | :heavy_check_mark: | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | +| `model` | *str* | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `diarize` | *Optional[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 | +| `keyterms` | List[*str*] | :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` | *Optional[str]* | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | +| `provider` | [Optional[components.STTRequestProvider]](../../components/sttrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `response_format` | [Optional[components.STTRequestResponseFormat]](../../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 | +| `session_id` | *Optional[str]* | :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` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature for transcription | 0 | +| `timestamp_granularities` | List[[components.STTTimestampGranularity](../../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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -116,23 +116,23 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `model` | *str* | ✅ | The model to use for transcription. | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `diarize` | *Optional[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` | [Optional[operations.CreateAudioTranscriptionsMultipartFile]](../../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` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | The language of the input audio (ISO-639-1). | -| `provider` | *Optional[str]* | ➖ | 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. | -| `response_format` | [Optional[operations.ResponseFormat]](../../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). | -| `session_id` | *Optional[str]* | ➖ | 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. | -| `source_url` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | The sampling temperature. | -| `timestamp_granularities` | List[[operations.TimestampGranularities](../../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `model` | *str* | :heavy_check_mark: | The model to use for transcription. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `diarize` | *Optional[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` | [Optional[operations.CreateAudioTranscriptionsMultipartFile]](../../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` | List[*str*] | :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` | *Optional[str]* | :heavy_minus_sign: | The language of the input audio (ISO-639-1). | +| `provider` | *Optional[str]* | :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. | +| `response_format` | [Optional[operations.ResponseFormat]](../../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). | +| `session_id` | *Optional[str]* | :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. | +| `source_url` | *Optional[str]* | :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` | *Optional[float]* | :heavy_minus_sign: | The sampling temperature. | +| `timestamp_granularities` | List[[operations.TimestampGranularities](../../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` | *Optional[str]* | :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` | *Optional[str]* | :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. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/systemone/README.mdx b/docs/sdks/systemone/README.mdx index 3fe9cdd04..fc7688ebe 100644 --- a/docs/sdks/systemone/README.mdx +++ b/docs/sdks/systemone/README.mdx @@ -70,17 +70,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *str* | ✅ | N/A | | -| `questions` | Dict[str, [components.Questions](../../components/questions.mdx)] | ✅ | N/A | | -| `state` | [components.State](../../components/state.mdx) | ✅ | The content to evaluate: a plain string, or a JSON object or array of related context. | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | ➖ | 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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | N/A | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `questions` | Dict[str, [components.Questions](../../components/questions.mdx)] | :heavy_check_mark: | N/A | | +| `state` | [components.State](../../components/state.mdx) | :heavy_check_mark: | The content to evaluate: a plain string, or a JSON object or array of related context. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | :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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/tools/README.mdx b/docs/sdks/tools/README.mdx index 8eca33655..1dd30f0b8 100644 --- a/docs/sdks/tools/README.mdx +++ b/docs/sdks/tools/README.mdx @@ -42,14 +42,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `security` | [operations.ListToolsSecurity](../../operations/listtoolssecurity.mdx) | ✅ | N/A | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | -| `api_format` | [Optional[operations.APIFormat]](../../operations/apiformat.mdx) | ➖ | Only tools usable on this API format | responses | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `security` | [operations.ListToolsSecurity](../../operations/listtoolssecurity.mdx) | :heavy_check_mark: | N/A | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | +| `api_format` | [Optional[operations.APIFormat]](../../operations/apiformat.mdx) | :heavy_minus_sign: | Only tools usable on this API format | responses | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -95,12 +95,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `security` | [operations.GetToolSecurity](../../operations/gettoolsecurity.mdx) | ✅ | N/A | | -| `name` | *str* | ✅ | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `security` | [operations.GetToolSecurity](../../operations/gettoolsecurity.mdx) | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/tts/README.mdx b/docs/sdks/tts/README.mdx index f459eacfb..7b3c78a73 100644 --- a/docs/sdks/tts/README.mdx +++ b/docs/sdks/tts/README.mdx @@ -40,21 +40,21 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `input` | [components.SpeechInput](../../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 | -| `model` | *str* | ✅ | TTS model identifier | mistralai/voxtral-mini-tts-2603 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `input_references` | List[[components.SpeechInputReference](../../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` | *Optional[str]* | ➖ | 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. | -| `provider` | [Optional[components.SpeechRequestProvider]](../../components/speechrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `response_format` | [Optional[components.SpeechRequestResponseFormat]](../../components/speechrequestresponseformat.mdx) | ➖ | Audio output format | pcm | -| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | 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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Voice identifier (provider-specific). | en_paul_neutral | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `input` | [components.SpeechInput](../../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 supported by Gemini TTS models and by Fish Audio models other than S1. | Hello world | +| `model` | *str* | :heavy_check_mark: | TTS model identifier | mistralai/voxtral-mini-tts-2603 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `input_references` | List[[components.SpeechInputReference](../../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` | *Optional[str]* | :heavy_minus_sign: | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers. | Speak in a warm and friendly tone. | +| `provider` | [Optional[components.SpeechRequestProvider]](../../components/speechrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `response_format` | [Optional[components.SpeechRequestResponseFormat]](../../components/speechrequestresponseformat.mdx) | :heavy_minus_sign: | Audio output format | pcm | +| `session_id` | *Optional[str]* | :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` | *Optional[float]* | :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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Voice identifier (provider-specific). | en_paul_neutral | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/vault/README.mdx b/docs/sdks/vault/README.mdx index 69833a005..8d9386c0a 100644 --- a/docs/sdks/vault/README.mdx +++ b/docs/sdks/vault/README.mdx @@ -47,13 +47,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -104,13 +104,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -160,12 +160,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *str* | :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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Errors @@ -544,14 +544,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `hosts` | List[*str*] | ✅ | 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` | *str* | ✅ | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *str* | :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 | +| `hosts` | List[*str*] | :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` | *str* | :heavy_check_mark: | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -936,12 +936,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `names` | List[*str*] | ✅ | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `names` | List[*str*] | :heavy_check_mark: | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -994,12 +994,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -1049,11 +1049,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | :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 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Errors @@ -1410,13 +1410,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `hosts` | List[*str*] | ✅ | 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` | *str* | ✅ | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | :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 | +| `hosts` | List[*str*] | :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` | *str* | :heavy_check_mark: | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/videogeneration/README.mdx b/docs/sdks/videogeneration/README.mdx index df613b8e2..f317b0a45 100644 --- a/docs/sdks/videogeneration/README.mdx +++ b/docs/sdks/videogeneration/README.mdx @@ -43,28 +43,28 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *str* | ✅ | N/A | | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `aspect_ratio` | [Optional[components.VideoGenerationRequestAspectRatio]](../../components/videogenerationrequestaspectratio.mdx) | ➖ | Aspect ratio of the generated video | 16:9 | -| `callback_url` | *Optional[str]* | ➖ | 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` | *Optional[int]* | ➖ | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | -| `duration` | *Optional[int]* | ➖ | Duration of the generated video in seconds | 8 | -| `frame_images` | List[[components.FrameImage](../../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. | | -| `generate_audio` | *Optional[bool]* | ➖ | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | -| `input_references` | List[[components.InputReference](../../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. | | -| `previous_job_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.VideoGenerationRequestProvider]](../../components/videogenerationrequestprovider.mdx) | ➖ | Provider-specific passthrough configuration | | -| `resolution` | [Optional[components.VideoGenerationRequestResolution]](../../components/videogenerationrequestresolution.mdx) | ➖ | Resolution of the generated video | 720p | -| `seed` | *Optional[int]* | ➖ | 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. | | -| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | -| `trace` | [Optional[components.TraceConfig]](../../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"
} | -| `upscale_factor` | *Optional[float]* | ➖ | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | -| `user` | *Optional[str]* | ➖ | 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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `model` | *str* | :heavy_check_mark: | N/A | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `aspect_ratio` | [Optional[components.VideoGenerationRequestAspectRatio]](../../components/videogenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | +| `callback_url` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | +| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | +| `frame_images` | List[[components.FrameImage](../../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. | | +| `generate_audio` | *Optional[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 | +| `input_references` | List[[components.InputReference](../../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. | | +| `previous_job_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | [Optional[components.VideoGenerationRequestProvider]](../../components/videogenerationrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | +| `resolution` | [Optional[components.VideoGenerationRequestResolution]](../../components/videogenerationrequestresolution.mdx) | :heavy_minus_sign: | Resolution of the generated video | 720p | +| `seed` | *Optional[int]* | :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. | | +| `session_id` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | +| `trace` | [Optional[components.TraceConfig]](../../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"
} | +| `upscale_factor` | *Optional[float]* | :heavy_minus_sign: | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | +| `user` | *Optional[str]* | :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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -113,11 +113,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `job_id` | *str* | ✅ | N/A | job-abc123 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -162,12 +162,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `job_id` | *str* | ✅ | N/A | job-abc123 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `index` | *OptionalNullable[int]* | ➖ | N/A | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `index` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -216,10 +216,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/workspaces/README.mdx b/docs/sdks/workspaces/README.mdx index f45ce4cc5..bf6f0de6a 100644 --- a/docs/sdks/workspaces/README.mdx +++ b/docs/sdks/workspaces/README.mdx @@ -53,12 +53,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -101,22 +101,22 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | ✅ | Name for the new workspace | Production | -| `slug` | *str* | ✅ | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `default_image_model` | *OptionalNullable[str]* | ➖ | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | ➖ | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | ➖ | Description of the workspace | Production environment workspace | -| `disabled_server_tools` | List[[components.CreateWorkspaceRequestDisabledServerTool](../../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"
] | -| `io_logging_api_key_ids` | List[*int*] | ➖ | Optional array of API key IDs to filter I/O logging | null | -| `io_logging_sampling_rate` | *Optional[float]* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | ➖ | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | ➖ | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | ➖ | Whether private logging is enabled | false | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | :heavy_check_mark: | Name for the new workspace | Production | +| `slug` | *str* | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the workspace | Production environment workspace | +| `disabled_server_tools` | List[[components.CreateWorkspaceRequestDisabledServerTool](../../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"
] | +| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | +| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | +| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | +| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | +| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -161,12 +161,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `confirm_default_workspace_deletion` | *Optional[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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `confirm_default_workspace_deletion` | *Optional[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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -212,11 +212,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -260,23 +260,23 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `default_image_model` | *OptionalNullable[str]* | ➖ | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | ➖ | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | ➖ | New description for the workspace | Updated description | -| `disabled_server_tools` | List[[components.UpdateWorkspaceRequestDisabledServerTool](../../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"
] | -| `io_logging_api_key_ids` | List[*int*] | ➖ | Optional array of API key IDs to filter I/O logging | null | -| `io_logging_sampling_rate` | *Optional[float]* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | ➖ | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | ➖ | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | ➖ | Whether private logging is enabled | false | -| `name` | *Optional[str]* | ➖ | New name for the workspace | Updated Workspace | -| `slug` | *Optional[str]* | ➖ | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | +| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the workspace | Updated description | +| `disabled_server_tools` | List[[components.UpdateWorkspaceRequestDisabledServerTool](../../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"
] | +| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | +| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | +| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | +| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | +| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | +| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the workspace | Updated Workspace | +| `slug` | *Optional[str]* | :heavy_minus_sign: | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -324,13 +324,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -378,12 +378,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `user_ids` | List[*str*] | ✅ | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `user_ids` | List[*str*] | :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"
] | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -432,12 +432,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `user_ids` | List[*str*] | ✅ | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `user_ids` | List[*str*] | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -483,11 +483,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -531,12 +531,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -581,12 +581,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response @@ -631,14 +631,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `limit_usd` | *float* | ✅ | Spending limit in USD. Must be greater than 0. | 100 | -| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `include_byok_in_budgets` | *Optional[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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `limit_usd` | *float* | :heavy_check_mark: | Spending limit in USD. Must be greater than 0. | 100 | +| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `include_byok_in_budgets` | *Optional[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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/pyproject.toml b/pyproject.toml index 89e32936f..951c4e488 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "openrouter" -version = "1.3.45" +version = "1.3.46" description = "Official Python Client SDK for OpenRouter." authors = [{ name = "OpenRouter" },] readme = "README-PYPI.md" diff --git a/src/openrouter/_version.py b/src/openrouter/_version.py index d1c45a6fa..8022b124a 100644 --- a/src/openrouter/_version.py +++ b/src/openrouter/_version.py @@ -3,10 +3,10 @@ import importlib.metadata __title__: str = "openrouter" -__version__: str = "1.3.45" +__version__: str = "1.3.46" __openapi_doc_version__: str = "1.0.0" __gen_version__: str = "2.914.0" -__user_agent__: str = "speakeasy-sdk/python 1.3.45 2.914.0 1.0.0 openrouter" +__user_agent__: str = "speakeasy-sdk/python 1.3.46 2.914.0 1.0.0 openrouter" try: if __package__ is not None: diff --git a/src/openrouter/components/createguardrailrequest.py b/src/openrouter/components/createguardrailrequest.py index d3cb25c2a..77ce30da9 100644 --- a/src/openrouter/components/createguardrailrequest.py +++ b/src/openrouter/components/createguardrailrequest.py @@ -24,6 +24,8 @@ class CreateGuardrailRequestTypedDict(TypedDict): name: str r"""Name for the new guardrail""" + allow_safety_retention_google: NotRequired[Nullable[bool]] + r"""Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided.""" allowed_data_regions: NotRequired[Nullable[List[GuardrailDataRegion]]] r"""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.""" allowed_models: NotRequired[Nullable[List[str]]] @@ -74,6 +76,9 @@ class CreateGuardrailRequest(BaseModel): name: str r"""Name for the new guardrail""" + allow_safety_retention_google: OptionalNullable[bool] = UNSET + r"""Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided.""" + allowed_data_regions: OptionalNullable[List[GuardrailDataRegion]] = UNSET r"""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.""" @@ -148,6 +153,7 @@ class CreateGuardrailRequest(BaseModel): def serialize_model(self, handler): optional_fields = set( [ + "allow_safety_retention_google", "allowed_data_regions", "allowed_models", "allowed_providers", @@ -173,6 +179,7 @@ def serialize_model(self, handler): ) nullable_fields = set( [ + "allow_safety_retention_google", "allowed_data_regions", "allowed_models", "allowed_providers", diff --git a/src/openrouter/components/guardrail.py b/src/openrouter/components/guardrail.py index c58c49089..60bef2177 100644 --- a/src/openrouter/components/guardrail.py +++ b/src/openrouter/components/guardrail.py @@ -32,6 +32,8 @@ class GuardrailTypedDict(TypedDict): r"""Name of the guardrail""" workspace_id: Nullable[str] r"""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.""" + allow_safety_retention_google: NotRequired[Nullable[bool]] + r"""Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided.""" allowed_data_regions: NotRequired[Nullable[List[GuardrailDataRegion]]] r"""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.""" allowed_models: NotRequired[Nullable[List[str]]] @@ -92,6 +94,9 @@ class Guardrail(BaseModel): workspace_id: Nullable[str] r"""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.""" + allow_safety_retention_google: OptionalNullable[bool] = UNSET + r"""Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided.""" + allowed_data_regions: OptionalNullable[List[GuardrailDataRegion]] = UNSET r"""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.""" @@ -161,6 +166,7 @@ class Guardrail(BaseModel): def serialize_model(self, handler): optional_fields = set( [ + "allow_safety_retention_google", "allowed_data_regions", "allowed_models", "allowed_providers", @@ -185,6 +191,7 @@ def serialize_model(self, handler): ) nullable_fields = set( [ + "allow_safety_retention_google", "allowed_data_regions", "allowed_models", "allowed_providers", diff --git a/src/openrouter/components/speechinput.py b/src/openrouter/components/speechinput.py index 676f38928..e85b5d8ef 100644 --- a/src/openrouter/components/speechinput.py +++ b/src/openrouter/components/speechinput.py @@ -9,8 +9,8 @@ SpeechInputTypedDict = TypeAliasType( "SpeechInputTypedDict", Union[str, List[SpeechTurnTypedDict]] ) -r"""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.""" +r"""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 supported by Gemini TTS models and by Fish Audio models other than S1.""" SpeechInput = TypeAliasType("SpeechInput", Union[str, List[SpeechTurn]]) -r"""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.""" +r"""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 supported by Gemini TTS models and by Fish Audio models other than S1.""" diff --git a/src/openrouter/components/speechrequest.py b/src/openrouter/components/speechrequest.py index ad116652e..ea07e4017 100644 --- a/src/openrouter/components/speechrequest.py +++ b/src/openrouter/components/speechrequest.py @@ -103,13 +103,13 @@ class SpeechRequestTypedDict(TypedDict): r"""Text-to-speech request input""" input: SpeechInputTypedDict - r"""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.""" + r"""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 supported by Gemini TTS models and by Fish Audio models other than S1.""" model: str r"""TTS model identifier""" input_references: NotRequired[List[SpeechInputReferenceTypedDict]] r"""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.""" instructions: NotRequired[str] - r"""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.""" + r"""Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers.""" provider: NotRequired[SpeechRequestProviderTypedDict] r"""Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options""" response_format: NotRequired[SpeechRequestResponseFormat] @@ -130,7 +130,7 @@ class SpeechRequest(BaseModel): r"""Text-to-speech request input""" input: SpeechInput - r"""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.""" + r"""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 supported by Gemini TTS models and by Fish Audio models other than S1.""" model: str r"""TTS model identifier""" @@ -139,7 +139,7 @@ class SpeechRequest(BaseModel): r"""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.""" instructions: Optional[str] = None - r"""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.""" + r"""Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers.""" provider: Optional[SpeechRequestProvider] = None r"""Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options""" diff --git a/src/openrouter/components/updateguardrailrequest.py b/src/openrouter/components/updateguardrailrequest.py index 21afa8a30..17311e522 100644 --- a/src/openrouter/components/updateguardrailrequest.py +++ b/src/openrouter/components/updateguardrailrequest.py @@ -22,6 +22,8 @@ class UpdateGuardrailRequestTypedDict(TypedDict): + allow_safety_retention_google: NotRequired[Nullable[bool]] + r"""Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided.""" allowed_data_regions: NotRequired[Nullable[List[GuardrailDataRegion]]] r"""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.""" allowed_models: NotRequired[Nullable[List[str]]] @@ -69,6 +71,9 @@ class UpdateGuardrailRequestTypedDict(TypedDict): class UpdateGuardrailRequest(BaseModel): + allow_safety_retention_google: OptionalNullable[bool] = UNSET + r"""Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided.""" + allowed_data_regions: OptionalNullable[List[GuardrailDataRegion]] = UNSET r"""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.""" @@ -143,6 +148,7 @@ class UpdateGuardrailRequest(BaseModel): def serialize_model(self, handler): optional_fields = set( [ + "allow_safety_retention_google", "allowed_data_regions", "allowed_models", "allowed_providers", @@ -168,6 +174,7 @@ def serialize_model(self, handler): ) nullable_fields = set( [ + "allow_safety_retention_google", "allowed_data_regions", "allowed_models", "allowed_providers", diff --git a/src/openrouter/guardrails.py b/src/openrouter/guardrails.py index 785964ad3..f61504951 100644 --- a/src/openrouter/guardrails.py +++ b/src/openrouter/guardrails.py @@ -357,6 +357,7 @@ def create( http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, + allow_safety_retention_google: OptionalNullable[bool] = UNSET, allowed_data_regions: OptionalNullable[ Iterable[components.GuardrailDataRegion] ] = UNSET, @@ -407,6 +408,7 @@ def create( :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings. + :param allow_safety_retention_google: Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. :param allowed_data_regions: 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. :param allowed_models: Array of model identifiers (slug or canonical_slug accepted) :param allowed_providers: List of allowed provider IDs @@ -448,6 +450,7 @@ def create( x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, create_guardrail_request=components.CreateGuardrailRequest( + allow_safety_retention_google=allow_safety_retention_google, allowed_data_regions=utils.unmarshal( allowed_data_regions, OptionalNullable[List[components.GuardrailDataRegion]], @@ -591,6 +594,7 @@ async def create_async( http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, + allow_safety_retention_google: OptionalNullable[bool] = UNSET, allowed_data_regions: OptionalNullable[ Iterable[components.GuardrailDataRegion] ] = UNSET, @@ -641,6 +645,7 @@ async def create_async( :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings. + :param allow_safety_retention_google: Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. :param allowed_data_regions: 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. :param allowed_models: Array of model identifiers (slug or canonical_slug accepted) :param allowed_providers: List of allowed provider IDs @@ -682,6 +687,7 @@ async def create_async( x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, create_guardrail_request=components.CreateGuardrailRequest( + allow_safety_retention_google=allow_safety_retention_google, allowed_data_regions=utils.unmarshal( allowed_data_regions, OptionalNullable[List[components.GuardrailDataRegion]], @@ -1337,6 +1343,7 @@ def update( http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, + allow_safety_retention_google: OptionalNullable[bool] = UNSET, allowed_data_regions: OptionalNullable[ Iterable[components.GuardrailDataRegion] ] = UNSET, @@ -1387,6 +1394,7 @@ def update( :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings. + :param allow_safety_retention_google: Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. :param allowed_data_regions: 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. :param allowed_models: Array of model identifiers (slug or canonical_slug accepted) :param allowed_providers: New list of allowed provider IDs @@ -1429,6 +1437,7 @@ def update( x_open_router_categories=x_open_router_categories, id=id, update_guardrail_request=components.UpdateGuardrailRequest( + allow_safety_retention_google=allow_safety_retention_google, allowed_data_regions=utils.unmarshal( allowed_data_regions, OptionalNullable[List[components.GuardrailDataRegion]], @@ -1581,6 +1590,7 @@ async def update_async( http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, + allow_safety_retention_google: OptionalNullable[bool] = UNSET, allowed_data_regions: OptionalNullable[ Iterable[components.GuardrailDataRegion] ] = UNSET, @@ -1631,6 +1641,7 @@ async def update_async( :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings. + :param allow_safety_retention_google: Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. :param allowed_data_regions: 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. :param allowed_models: Array of model identifiers (slug or canonical_slug accepted) :param allowed_providers: New list of allowed provider IDs @@ -1673,6 +1684,7 @@ async def update_async( x_open_router_categories=x_open_router_categories, id=id, update_guardrail_request=components.UpdateGuardrailRequest( + allow_safety_retention_google=allow_safety_retention_google, allowed_data_regions=utils.unmarshal( allowed_data_regions, OptionalNullable[List[components.GuardrailDataRegion]], diff --git a/src/openrouter/tts.py b/src/openrouter/tts.py index 5b1bf2a61..001335f1d 100644 --- a/src/openrouter/tts.py +++ b/src/openrouter/tts.py @@ -51,7 +51,7 @@ def create_speech( Synthesizes audio from the input text. Returns a raw audio bytestream in the requested format (e.g. mp3, pcm, wav). - :param input: 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. + :param input: 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 supported by Gemini TTS models and by Fish Audio models other than S1. :param model: TTS model identifier :param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings. This is used to track API usage per application. @@ -61,7 +61,7 @@ def create_speech( :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings. :param input_references: 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. - :param instructions: 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. + :param instructions: Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers. :param provider: Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options :param response_format: Audio output format :param session_id: 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. @@ -307,7 +307,7 @@ async def create_speech_async( Synthesizes audio from the input text. Returns a raw audio bytestream in the requested format (e.g. mp3, pcm, wav). - :param input: 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. + :param input: 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 supported by Gemini TTS models and by Fish Audio models other than S1. :param model: TTS model identifier :param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings. This is used to track API usage per application. @@ -317,7 +317,7 @@ async def create_speech_async( :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings. :param input_references: 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. - :param instructions: 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. + :param instructions: Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers. :param provider: Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options :param response_format: Audio output format :param session_id: 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. diff --git a/uv.lock b/uv.lock index c43fa628e..bdc8fc920 100644 --- a/uv.lock +++ b/uv.lock @@ -213,7 +213,7 @@ wheels = [ [[package]] name = "openrouter" -version = "1.3.45" +version = "1.3.46" source = { editable = "." } dependencies = [ { name = "httpcore" }, From 35c7a9c92ed032a1c84c081701fe4896bbd19d03 Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Tue, 13 Oct 2026 19:34:40 +0000 Subject: [PATCH 2/3] empty commit to trigger [run-tests] workflow From e1267e8e228c38bb72585a229879e55de399d7a5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 13 Oct 2026 19:34:55 +0000 Subject: [PATCH 3/3] Chore: regenerate docs navigation Auto-generated-by: update-generated-files-action; https://github.com/OpenRouterTeam/python-sdk/actions/runs/38455945058 --- docs/components/aabenchmarkentry.mdx | 6 +- docs/components/activityitem.mdx | 26 +- docs/components/activityresponse.mdx | 2 +- docs/components/additionaltoolsitem.mdx | 8 +- docs/components/additionaltoolsitemtool.mdx | 4 +- .../additionaltoolsitemtoolfunction.mdx | 18 +- docs/components/advisorreasoning.mdx | 4 +- docs/components/advisorservertoolconfig.mdx | 16 +- .../advisorservertoolopenrouter.mdx | 4 +- docs/components/agent.mdx | 4 +- docs/components/agentmessageitem.mdx | 14 +- .../agentmessageitemcontentinputimage.mdx | 8 +- docs/components/alignment.mdx | 2 +- .../components/alignmentallowedcallrecord.mdx | 6 +- .../components/alignmentblockedcallrecord.mdx | 6 +- docs/components/alignmentchataudio.mdx | 4 +- docs/components/alignmentchatimage.mdx | 4 +- .../components/alignmentchatimageimageurl.mdx | 2 +- docs/components/alignmentchatrejected.mdx | 12 +- docs/components/alignmentchattoolcall.mdx | 6 +- .../alignmentchattoolcallfunction.mdx | 4 +- docs/components/alignmentplugin.mdx | 12 +- docs/components/alignmentrulerecord.mdx | 4 +- .../alignmentunavailablecallrecord.mdx | 6 +- docs/components/allowedtools.mdx | 4 +- docs/components/always.mdx | 2 +- docs/components/annotationaddedevent.mdx | 14 +- docs/components/annotationfile.mdx | 4 +- docs/components/annotationurlcitation.mdx | 4 +- .../annotationwebsearchcitation.mdx | 4 +- .../anthropicadvisormessageusageiteration.mdx | 14 +- .../components/anthropicadvisortoolresult.mdx | 6 +- .../components/anthropicbase64imagesource.mdx | 6 +- docs/components/anthropicbase64pdfsource.mdx | 6 +- .../anthropicbashcodeexecutionoutput.mdx | 4 +- .../anthropicbashcodeexecutionresult.mdx | 10 +- .../anthropicbashcodeexecutiontoolresult.mdx | 6 +- ...hropicbashcodeexecutiontoolresulterror.mdx | 4 +- .../anthropiccachecontroldirective.mdx | 4 +- docs/components/anthropiccachecreation.mdx | 4 +- .../anthropiccitationcharlocation.mdx | 14 +- .../anthropiccitationcharlocationparam.mdx | 12 +- .../anthropiccitationcontentblocklocation.mdx | 14 +- ...ropiccitationcontentblocklocationparam.mdx | 12 +- .../anthropiccitationpagelocation.mdx | 14 +- .../anthropiccitationpagelocationparam.mdx | 12 +- docs/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 +- docs/components/anthropiccompactionblock.mdx | 6 +- .../anthropiccompactionusageiteration.mdx | 12 +- docs/components/anthropiccontainer.mdx | 6 +- docs/components/anthropiccontainerskill.mdx | 6 +- docs/components/anthropiccontainerupload.mdx | 4 +- docs/components/anthropicdirectcaller.mdx | 2 +- docs/components/anthropicdocumentblock.mdx | 8 +- .../anthropicdocumentblockparam.mdx | 12 +- .../anthropicdocumentblockparamcitations.mdx | 2 +- .../anthropicencryptedcodeexecutionresult.mdx | 10 +- docs/components/anthropicfile.mdx | 16 +- docs/components/anthropicfiledeleted.mdx | 6 +- .../anthropicfiledocumentsource.mdx | 4 +- docs/components/anthropicfilelist.mdx | 10 +- docs/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 +- docs/components/anthropicplaintextsource.mdx | 6 +- .../anthropicredactedthinkingblock.mdx | 4 +- .../anthropicrefusalstopdetails.mdx | 6 +- docs/components/anthropicsafeguard.mdx | 6 +- .../anthropicsearchresultblockparam.mdx | 12 +- ...thropicsearchresultblockparamcitations.mdx | 2 +- docs/components/anthropicservertoolusage.mdx | 4 +- docs/components/anthropictextblock.mdx | 6 +- docs/components/anthropictextblockparam.mdx | 8 +- ...pictexteditorcodeexecutioncreateresult.mdx | 4 +- ...exteditorcodeexecutionstrreplaceresult.mdx | 12 +- ...ropictexteditorcodeexecutiontoolresult.mdx | 6 +- ...texteditorcodeexecutiontoolresulterror.mdx | 6 +- ...ropictexteditorcodeexecutionviewresult.mdx | 12 +- docs/components/anthropicthinkingblock.mdx | 6 +- .../anthropicthinkingblockbinding.mdx | 4 +- docs/components/anthropicthinkingturns.mdx | 4 +- docs/components/anthropictoolreference.mdx | 4 +- docs/components/anthropictoolsearchresult.mdx | 4 +- .../anthropictoolsearchresulterror.mdx | 6 +- .../anthropictoolsearchtoolbm25.mdx | 12 +- .../anthropictoolsearchtoolregex.mdx | 12 +- .../anthropictoolsearchtoolresult.mdx | 6 +- docs/components/anthropictooluseblock.mdx | 10 +- docs/components/anthropictooluseskeep.mdx | 4 +- docs/components/anthropictoolusestrigger.mdx | 4 +- .../anthropicunknownusageiteration.mdx | 12 +- docs/components/anthropicurlimagesource.mdx | 4 +- docs/components/anthropicurlpdfsource.mdx | 4 +- docs/components/anthropicwebfetchblock.mdx | 8 +- .../anthropicwebfetchtoolresult.mdx | 8 +- .../anthropicwebfetchtoolresulterror.mdx | 4 +- docs/components/anthropicwebsearchresult.mdx | 10 +- .../anthropicwebsearchresultblockparam.mdx | 10 +- .../anthropicwebsearchtoolresult.mdx | 8 +- .../anthropicwebsearchtoolresulterror.mdx | 4 +- .../anthropicwebsearchtooluserlocation.mdx | 10 +- docs/components/applypatchcallitem.mdx | 10 +- .../applypatchcalloperationdiffdeltaevent.mdx | 10 +- .../applypatchcalloperationdiffdoneevent.mdx | 10 +- docs/components/applypatchcalloutputitem.mdx | 10 +- .../applypatchcreatefileoperation.mdx | 6 +- .../applypatchdeletefileoperation.mdx | 4 +- docs/components/applypatchservertool.mdx | 2 +- .../components/applypatchservertoolconfig.mdx | 2 +- .../applypatchservertoolopenrouter.mdx | 4 +- .../applypatchupdatefileoperation.mdx | 6 +- docs/components/apprankingsitem.mdx | 10 +- docs/components/apprankingsresponse.mdx | 4 +- docs/components/architecture.mdx | 10 +- docs/components/audiourl.mdx | 2 +- docs/components/autobetarouterplugin.mdx | 12 +- docs/components/autorouterplugin.mdx | 14 +- .../badgatewayresponseerrordata.mdx | 6 +- .../badrequestresponseerrordata.mdx | 6 +- docs/components/baseinputsmessage.mdx | 8 +- docs/components/basereasoningconfig.mdx | 8 +- docs/components/bashservertool.mdx | 4 +- docs/components/bashservertoolconfig.mdx | 4 +- docs/components/batchdeletedobject.mdx | 6 +- docs/components/batchdeletiontargets.mdx | 4 +- docs/components/batcherrorresponseerror.mdx | 4 +- docs/components/batchlistitem.mdx | 24 +- .../batchlistitemcompletiontokensdetails.mdx | 6 +- docs/components/batchlistitemerror.mdx | 2 +- .../batchlistitemprompttokensdetails.mdx | 10 +- .../components/batchlistitemrequestcounts.mdx | 6 +- .../components/batchlistitemservertooluse.mdx | 6 +- docs/components/batchlistitemusage.mdx | 26 +- docs/components/batchlistresponse.mdx | 10 +- docs/components/batchobject.mdx | 24 +- .../batchobjectcompletiontokensdetails.mdx | 6 +- docs/components/batchobjectdata.mdx | 6 +- docs/components/batchobjectdebug.mdx | 6 +- docs/components/batchobjecterror.mdx | 2 +- docs/components/batchobjectfile.mdx | 6 +- docs/components/batchobjectfunction.mdx | 4 +- docs/components/batchobjectimageurl.mdx | 2 +- .../batchobjectprompttokensdetails.mdx | 10 +- docs/components/batchobjectrequestcounts.mdx | 6 +- docs/components/batchobjectresponse.mdx | 6 +- docs/components/batchobjectservertooluse.mdx | 6 +- .../batchobjectservertoolusedetails.mdx | 6 +- docs/components/batchobjecttimings.mdx | 6 +- docs/components/batchobjecturlcitation.mdx | 10 +- docs/components/batchobjectusage.mdx | 26 +- ...equiredresponsecompletiontokensdetails.mdx | 6 +- .../batchpaymentrequiredresponseerror.mdx | 4 +- ...entrequiredresponseprompttokensdetails.mdx | 10 +- ...chpaymentrequiredresponserequestcounts.mdx | 6 +- ...chpaymentrequiredresponseservertooluse.mdx | 6 +- .../batchpaymentrequiredresponseusage.mdx | 26 +- docs/components/batchproviderpreferences.mdx | 4 +- docs/components/batchsubmitbody.mdx | 10 +- docs/components/bodychatcompletion.mdx | 24 +- .../bodycompletiontokensdetails.mdx | 6 +- docs/components/bodylist.mdx | 10 +- docs/components/bodymessage.mdx | 22 +- docs/components/bodyprompttokensdetails1.mdx | 10 +- docs/components/bodyprompttokensdetails2.mdx | 10 +- docs/components/bodyservertooluse.mdx | 6 +- docs/components/bodyusage1.mdx | 14 +- docs/components/bodyusage2.mdx | 22 +- docs/components/bodyusage3.mdx | 12 +- docs/components/booleancapability.mdx | 2 +- .../bulkaddworkspacemembersrequest.mdx | 2 +- .../bulkaddworkspacemembersresponse.mdx | 4 +- docs/components/bulkassignkeysrequest.mdx | 2 +- docs/components/bulkassignkeysresponse.mdx | 2 +- docs/components/bulkassignmembersrequest.mdx | 2 +- docs/components/bulkassignmembersresponse.mdx | 2 +- .../bulkremoveworkspacemembersrequest.mdx | 2 +- .../bulkremoveworkspacemembersresponse.mdx | 2 +- docs/components/bulkunassignkeysrequest.mdx | 2 +- docs/components/bulkunassignkeysresponse.mdx | 2 +- .../components/bulkunassignmembersrequest.mdx | 2 +- .../bulkunassignmembersresponse.mdx | 2 +- docs/components/byokkey.mdx | 32 +- docs/components/chatassistantimages.mdx | 2 +- .../chatassistantimagesimageurl.mdx | 2 +- docs/components/chatassistantmessage.mdx | 20 +- docs/components/chataudiooutput.mdx | 8 +- docs/components/chatchoice.mdx | 8 +- docs/components/chatcontentaudio.mdx | 4 +- .../components/chatcontentaudioinputaudio.mdx | 4 +- docs/components/chatcontentcachecontrol.mdx | 4 +- docs/components/chatcontentfile.mdx | 4 +- docs/components/chatcontentfilefile.mdx | 6 +- docs/components/chatcontentimage.mdx | 4 +- docs/components/chatcontentimageimageurl.mdx | 4 +- docs/components/chatcontenttext.mdx | 8 +- docs/components/chatcontentvideo.mdx | 4 +- docs/components/chatcontentvideoinput.mdx | 4 +- docs/components/chatdebugoptions.mdx | 2 +- docs/components/chatdevelopermessage.mdx | 8 +- ...hatdevelopermessageconfigurationupdate.mdx | 2 +- docs/components/chatdynamicservertool.mdx | 4 +- docs/components/chatformatgrammarconfig.mdx | 4 +- .../components/chatformatjsonobjectconfig.mdx | 2 +- .../components/chatformatjsonschemaconfig.mdx | 4 +- docs/components/chatformatpythonconfig.mdx | 2 +- docs/components/chatformattextconfig.mdx | 2 +- docs/components/chatfunctiontoolfunction.mdx | 8 +- .../chatfunctiontoolfunctionfunction.mdx | 10 +- docs/components/chatjsonschemaconfig.mdx | 8 +- docs/components/chatnamedtoolchoice.mdx | 4 +- .../chatnamedtoolchoicefunction.mdx | 2 +- docs/components/chatrequest.mdx | 84 ++--- docs/components/chatrequestreasoning.mdx | 4 +- docs/components/chatresult.mdx | 18 +- .../components/chatsearchmodelsservertool.mdx | 4 +- docs/components/chatservertoolchoice.mdx | 2 +- docs/components/chatstreamchoice.mdx | 8 +- docs/components/chatstreamchunk.mdx | 20 +- docs/components/chatstreamchunkerror.mdx | 6 +- docs/components/chatstreamchunkmetadata.mdx | 4 +- docs/components/chatstreamdelta.mdx | 14 +- docs/components/chatstreamingresponse.mdx | 2 +- docs/components/chatstreamoptions.mdx | 2 +- docs/components/chatstreamtoolcall.mdx | 8 +- .../components/chatstreamtoolcallfunction.mdx | 4 +- docs/components/chatsystemmessage.mdx | 8 +- .../chatsystemmessageconfigurationupdate.mdx | 2 +- docs/components/chattokenlogprob.mdx | 8 +- docs/components/chattokenlogprobs.mdx | 4 +- .../components/chattokenlogprobtoplogprob.mdx | 6 +- docs/components/chattoolcall.mdx | 6 +- docs/components/chattoolcallfunction.mdx | 4 +- docs/components/chattoolmessage.mdx | 6 +- docs/components/chatusage.mdx | 18 +- .../chatusagecompletiontokensdetails.mdx | 8 +- .../chatusageprompttokensdetails.mdx | 8 +- docs/components/chatusermessage.mdx | 6 +- docs/components/chatwebsearchshorthand.mdx | 26 +- docs/components/choice.mdx | 10 +- .../codeinterpretercallcodedeltaevent.mdx | 10 +- .../codeinterpretercallcodedoneevent.mdx | 10 +- .../codeinterpretercallcompletedevent.mdx | 8 +- .../codeinterpretercallinprogressevent.mdx | 8 +- .../codeinterpretercallinterpretingevent.mdx | 8 +- docs/components/codeinterpreterfileoutput.mdx | 20 +- .../components/codeinterpreterimageoutput.mdx | 4 +- docs/components/codeinterpreterlogsoutput.mdx | 4 +- docs/components/codeinterpreterservertool.mdx | 4 +- docs/components/codexlocalshelltool.mdx | 2 +- docs/components/compactionitem.mdx | 8 +- docs/components/compoundfilter.mdx | 4 +- docs/components/computeruseservertool.mdx | 8 +- docs/components/configurationupdateitem.mdx | 6 +- .../configurationupdatereasoning.mdx | 2 +- docs/components/conflictresponseerrordata.mdx | 6 +- docs/components/containerauto.mdx | 6 +- docs/components/containerautoenvironment.mdx | 6 +- docs/components/containerfile.mdx | 14 +- docs/components/containerfilelistresponse.mdx | 10 +- .../containernetworkpolicyallowlist.mdx | 4 +- .../containernetworkpolicydisabled.mdx | 2 +- .../containerreferenceenvironment.mdx | 8 +- docs/components/contentcompaction.mdx | 8 +- docs/components/contentencryptedcontent.mdx | 6 +- docs/components/contentfilterbuiltinentry.mdx | 8 +- .../contentfilterbuiltinentryinput.mdx | 8 +- docs/components/contentfilterentry.mdx | 6 +- docs/components/contentimageurl.mdx | 4 +- docs/components/contentimageurlimageurl.mdx | 2 +- docs/components/contentpartaddedevent.mdx | 12 +- docs/components/contentpartaudio.mdx | 4 +- docs/components/contentpartdoneevent.mdx | 12 +- docs/components/contentpartimage.mdx | 4 +- docs/components/contentpartimageimageurl.mdx | 2 +- docs/components/contentpartinputaudio.mdx | 4 +- docs/components/contentpartinputfile.mdx | 4 +- docs/components/contentpartinputvideo.mdx | 4 +- docs/components/contentpartvideo.mdx | 4 +- docs/components/contentredactedthinking.mdx | 4 +- docs/components/contentservertooluse.mdx | 10 +- docs/components/contenttext.mdx | 4 +- docs/components/contentthinking.mdx | 6 +- docs/components/contenttoolreference.mdx | 4 +- docs/components/contenttoolresult.mdx | 10 +- docs/components/contenttooluse.mdx | 10 +- docs/components/contenttoplogprob.mdx | 6 +- .../components/contentwebsearchtoolresult.mdx | 8 +- .../contentwebsearchtoolresulterror.mdx | 4 +- docs/components/contextcompactionitem.mdx | 8 +- docs/components/contextcompressionplugin.mdx | 6 +- docs/components/contextmanagement.mdx | 2 +- docs/components/contradiction.mdx | 4 +- docs/components/costdetails.mdx | 8 +- docs/components/createbyokkeyrequest.mdx | 26 +- docs/components/createbyokkeyresponse.mdx | 2 +- docs/components/createenduserrequest.mdx | 2 +- docs/components/createguardrailrequest.mdx | 46 +-- docs/components/createguardrailresponse.mdx | 2 +- docs/components/createinternrequest.mdx | 12 +- .../createobservabilitydestinationrequest.mdx | 28 +- ...createobservabilitydestinationresponse.mdx | 2 +- .../createpresetfrominferenceresponse.mdx | 2 +- .../createprivateendpointrequest.mdx | 16 +- ...teendpointvalidationfailedresponsedata.mdx | 4 +- ...eendpointvalidationfailedresponseerror.mdx | 4 +- .../createscimgroupmappingrequest.mdx | 6 +- .../createscimgroupmappingresponse.mdx | 2 +- docs/components/createscimsyncjobresponse.mdx | 2 +- docs/components/createworkspacerequest.mdx | 24 +- docs/components/createworkspaceresponse.mdx | 2 +- docs/components/customtool.mdx | 12 +- .../customtoolcallinputdeltaevent.mdx | 10 +- .../customtoolcallinputdoneevent.mdx | 10 +- docs/components/customtoolcallitem.mdx | 16 +- docs/components/customtoolcalloutputitem.mdx | 8 +- ...stomtoolcalloutputitemoutputinputimage.mdx | 8 +- docs/components/dabenchmarkentry.mdx | 10 +- docs/components/datetimeservertool.mdx | 4 +- docs/components/datetimeservertoolconfig.mdx | 2 +- docs/components/debugevent.mdx | 6 +- docs/components/debugeventdebug.mdx | 4 +- docs/components/debugeventtimings.mdx | 6 +- docs/components/decisions.mdx | 6 +- docs/components/decisionschoiceanswer.mdx | 8 +- docs/components/decisionschoicequestion.mdx | 6 +- docs/components/decisionsnoulanswer.mdx | 4 +- docs/components/decisionsnoulquestion.mdx | 6 +- .../decisionsnoulquestioncriteria.mdx | 4 +- docs/components/decisionsrequest.mdx | 14 +- docs/components/decisionsresponse.mdx | 10 +- docs/components/decisionsresponseusage.mdx | 6 +- docs/components/decisionsscoreanswer.mdx | 10 +- docs/components/decisionsscorequestion.mdx | 6 +- docs/components/defaultparameters.mdx | 12 +- docs/components/deferredbm25search.mdx | 4 +- docs/components/deferredcustomsearch.mdx | 8 +- docs/components/deferredregexsearch.mdx | 4 +- docs/components/deferredtoolscontrol.mdx | 8 +- docs/components/deletebyokkeyresponse.mdx | 2 +- docs/components/deleteguardrailresponse.mdx | 2 +- docs/components/deleteinternrequest.mdx | 2 +- docs/components/deleteinternresponse.mdx | 2 +- ...deleteobservabilitydestinationresponse.mdx | 2 +- .../deleteprivateendpointresponse.mdx | 2 +- .../deleteprivateendpointresponsedata.mdx | 2 +- .../deletescimgroupmappingresponse.mdx | 2 +- .../deleteworkspacebudgetresponse.mdx | 2 +- docs/components/deleteworkspaceresponse.mdx | 2 +- docs/components/easyinputmessage.mdx | 8 +- .../easyinputmessagecontentinputimage.mdx | 8 +- .../edgenetworktimeoutresponseerrordata.mdx | 6 +- docs/components/editclearthinking20251015.mdx | 4 +- docs/components/editcleartooluses20250919.mdx | 12 +- docs/components/editcompact20260112.mdx | 8 +- docs/components/embeddings.mdx | 6 +- docs/components/endpointinfo.mdx | 6 +- docs/components/endpointsmetadata.mdx | 4 +- docs/components/enduser.mdx | 8 +- docs/components/enduserresponse.mdx | 2 +- docs/components/enumcapability.mdx | 4 +- docs/components/errorevent.mdx | 10 +- docs/components/failedmodel.mdx | 6 +- docs/components/filecitation.mdx | 8 +- docs/components/fileparserplugin.mdx | 6 +- docs/components/filepath.mdx | 6 +- docs/components/filesearchservertool.mdx | 10 +- docs/components/filesservertool.mdx | 4 +- docs/components/filters.mdx | 6 +- .../components/forbiddenresponseerrordata.mdx | 6 +- docs/components/formatgrammar.mdx | 6 +- docs/components/formatjsonobjectconfig.mdx | 2 +- docs/components/formatjsonschemaconfig.mdx | 10 +- docs/components/formattext.mdx | 2 +- docs/components/formattextconfig.mdx | 2 +- docs/components/frameimage.mdx | 6 +- docs/components/frameimageimageurl.mdx | 2 +- docs/components/freemodeldailyrequests.mdx | 6 +- .../components/functioncallargsdeltaevent.mdx | 10 +- docs/components/functioncallargsdoneevent.mdx | 12 +- docs/components/functioncallitem.mdx | 20 +- .../functioncallitemsubagentitem.mdx | 4 +- docs/components/functioncalloutputitem.mdx | 10 +- ...functioncalloutputitemoutputinputimage.mdx | 8 +- docs/components/fusionanalysisresult.mdx | 10 +- .../fusioncallanalysiscompletedevent.mdx | 10 +- .../fusioncallanalysisinprogressevent.mdx | 12 +- docs/components/fusioncallcompletedevent.mdx | 8 +- docs/components/fusioncallinprogressevent.mdx | 8 +- docs/components/fusioncallpaneladdedevent.mdx | 10 +- .../fusioncallpanelcompletedevent.mdx | 12 +- docs/components/fusioncallpaneldeltaevent.mdx | 12 +- .../components/fusioncallpanelfailedevent.mdx | 14 +- .../fusioncallpanelreasoningdeltaevent.mdx | 12 +- docs/components/fusionplugin.mdx | 14 +- docs/components/fusionplugintool.mdx | 4 +- docs/components/fusionservertoolconfig.mdx | 16 +- .../fusionservertoolconfigreasoning.mdx | 4 +- .../components/fusionservertoolconfigtool.mdx | 4 +- .../components/fusionservertoolopenrouter.mdx | 4 +- docs/components/fusionsource.mdx | 4 +- .../gatewaytimeoutresponseerrordata.mdx | 6 +- docs/components/generationcontentdata.mdx | 6 +- .../generationcontentdataoutput.mdx | 4 +- docs/components/generationcontenterror.mdx | 10 +- .../generationcontenterrorattempt.mdx | 8 +- docs/components/generationcontentresponse.mdx | 2 +- docs/components/generationresponse.mdx | 2 +- docs/components/generationresponsedata.mdx | 90 +++--- docs/components/getbyokkeyresponse.mdx | 2 +- docs/components/getguardrailresponse.mdx | 2 +- .../getobservabilitydestinationresponse.mdx | 2 +- docs/components/getpresetresponse.mdx | 2 +- docs/components/getpresetversionresponse.mdx | 2 +- .../getscimgroupmappingresponse.mdx | 2 +- docs/components/getscimsyncjobresponse.mdx | 2 +- docs/components/gettoolresponse.mdx | 2 +- .../components/getworkspacebudgetresponse.mdx | 4 +- docs/components/getworkspaceresponse.mdx | 2 +- docs/components/goneresponseerrordata.mdx | 6 +- docs/components/guardrail.mdx | 52 +-- docs/components/image.mdx | 4 +- docs/components/imageendpoint.mdx | 14 +- .../components/imagegencallcompletedevent.mdx | 8 +- .../imagegencallgeneratingevent.mdx | 8 +- .../imagegencallinprogressevent.mdx | 8 +- .../imagegencallpartialimageevent.mdx | 12 +- docs/components/imagegencompletedevent.mdx | 10 +- docs/components/imagegeneration.mdx | 6 +- .../imagegenerationproviderpreferences.mdx | 12 +- ...gegenerationproviderpreferencesoptions.mdx | 292 ++++++++--------- docs/components/imagegenerationrequest.mdx | 34 +- docs/components/imagegenerationresponse.mdx | 6 +- .../imagegenerationresponsedata.mdx | 4 +- docs/components/imagegenerationservertool.mdx | 22 +- .../imagegenerationservertoolconfig.mdx | 4 +- .../imagegenerationservertoolopenrouter.mdx | 4 +- docs/components/imagegenerationusage.mdx | 26 +- ...generationusagecompletiontokensdetails.mdx | 6 +- ...magegenerationusageprompttokensdetails.mdx | 10 +- .../imagegenerationusageservertooluse.mdx | 6 +- docs/components/imagegenpartialimageevent.mdx | 6 +- docs/components/imagegenstreamerrorevent.mdx | 4 +- .../imagegenstreamerroreventerror.mdx | 8 +- docs/components/imagegentextchunkevent.mdx | 6 +- docs/components/imagemodelarchitecture.mdx | 4 +- .../imagemodelendpointsresponse.mdx | 4 +- docs/components/imagemodellistitem.mdx | 16 +- docs/components/imagemodelslistresponse.mdx | 2 +- docs/components/imagepricingentry.mdx | 8 +- docs/components/imagestreamingresponse.mdx | 2 +- docs/components/incompletedetails.mdx | 2 +- docs/components/input1.mdx | 2 +- docs/components/input2.mdx | 2 +- docs/components/inputaudio.mdx | 4 +- docs/components/inputaudioinputaudio.mdx | 4 +- docs/components/inputfile.mdx | 10 +- docs/components/inputimage.mdx | 8 +- docs/components/inputimagemask.mdx | 4 +- docs/components/inputmessageitem.mdx | 8 +- .../inputmessageitemcontentinputimage.mdx | 8 +- docs/components/inputschema.mdx | 8 +- docs/components/inputsmessage.mdx | 12 +- docs/components/inputsreasoning.mdx | 16 +- docs/components/inputtext.mdx | 6 +- docs/components/inputtokensdetails.mdx | 4 +- docs/components/inputvideo.mdx | 6 +- docs/components/intern.mdx | 28 +- .../internalserverresponseerrordata.mdx | 6 +- .../components/internchatassistantmessage.mdx | 6 +- docs/components/internchatchoice.mdx | 6 +- docs/components/internchatcompletionchunk.mdx | 16 +- .../internchatcompletionrequest.mdx | 10 +- docs/components/internchatdelta.mdx | 8 +- .../components/internchatdevelopermessage.mdx | 4 +- docs/components/internchatechoedtoolcall.mdx | 4 +- .../internchatechoedtoolcallfunction.mdx | 4 +- docs/components/internchaterror.mdx | 6 +- docs/components/internchaterrormetadata.mdx | 4 +- .../internchatprompttokensdetails.mdx | 2 +- docs/components/internchatsteeredresponse.mdx | 4 +- docs/components/internchatstreamerror.mdx | 6 +- .../internchatstreamingresponse.mdx | 2 +- docs/components/internchatsystemmessage.mdx | 4 +- docs/components/internchattextpart.mdx | 4 +- docs/components/internchattoolcall.mdx | 8 +- .../components/internchattoolcallfunction.mdx | 4 +- docs/components/internchattoolmessage.mdx | 6 +- docs/components/internchatusage.mdx | 10 +- docs/components/internchatusermessage.mdx | 4 +- docs/components/interndaemonaccess.mdx | 4 +- .../interninvokeacceptedresponse.mdx | 4 +- docs/components/interninvokerequest.mdx | 4 +- docs/components/internlifecycleerrorerror.mdx | 6 +- .../internlifecycleerrormetadata.mdx | 4 +- docs/components/internlistresponse.mdx | 6 +- docs/components/itemreferenceitem.mdx | 4 +- docs/components/jevrouterplugin.mdx | 10 +- docs/components/keepall.mdx | 2 +- docs/components/key.mdx | 14 +- docs/components/keyassignment.mdx | 14 +- docs/components/keybudget.mdx | 18 +- docs/components/legacychatcontentvideo.mdx | 6 +- .../legacychatcontentvideoinput.mdx | 4 +- docs/components/legacywebsearchservertool.mdx | 18 +- docs/components/listbyokkeysresponse.mdx | 4 +- docs/components/listendpointsresponse.mdx | 12 +- docs/components/listendusersresponse.mdx | 4 +- docs/components/listguardrailsresponse.mdx | 4 +- .../components/listkeyassignmentsresponse.mdx | 4 +- .../listmemberassignmentsresponse.mdx | 4 +- .../listobservabilitydestinationsresponse.mdx | 4 +- docs/components/listpresetsresponse.mdx | 4 +- .../components/listpresetversionsresponse.mdx | 4 +- .../listprivateendpointsresponse.mdx | 2 +- .../listscimgroupmappingsresponse.mdx | 4 +- docs/components/listscimgroupsresponse.mdx | 4 +- docs/components/listtoolsresponse.mdx | 6 +- docs/components/listtoolsresponselinks.mdx | 2 +- .../listworkspacebudgetsresponse.mdx | 4 +- .../listworkspacemembersresponse.mdx | 4 +- docs/components/listworkspacesresponse.mdx | 4 +- docs/components/localshellcallitem.mdx | 10 +- docs/components/localshellcallitemaction.mdx | 12 +- docs/components/localshellcalloutputitem.mdx | 8 +- docs/components/logprob.mdx | 8 +- docs/components/logprobs.mdx | 4 +- docs/components/logprobscontent.mdx | 8 +- docs/components/managedprivateendpoint.mdx | 18 +- .../managedprivateendpointresponse.mdx | 2 +- docs/components/match.mdx | 6 +- docs/components/maxprice.mdx | 10 +- docs/components/mcpapprovalrequestitem.mdx | 10 +- docs/components/mcpapprovalresponseitem.mdx | 10 +- docs/components/mcpcallitem.mdx | 14 +- docs/components/mcphttperror.mdx | 6 +- docs/components/mcplisttoolsitem.mdx | 10 +- docs/components/mcplisttoolsitemtool.mdx | 8 +- docs/components/mcpprotocolerror.mdx | 6 +- docs/components/mcpservertool.mdx | 18 +- docs/components/mcptoolexecutionerror.mdx | 4 +- docs/components/memberassignment.mdx | 12 +- docs/components/message.mdx | 16 +- .../messagesadvisortoolresultblock.mdx | 6 +- .../messagesbashtoolresultblock.mdx | 10 +- .../messagesbashtoolresultblockfile.mdx | 12 +- docs/components/messagesfallbackparam.mdx | 4 +- docs/components/messagesmessageparam.mdx | 8 +- docs/components/messagesoutputconfig.mdx | 6 +- .../components/messagesoutputconfigformat.mdx | 4 +- docs/components/messagesrequest.mdx | 56 ++-- docs/components/messagesrequestmetadata.mdx | 2 +- docs/components/messagesrequesttool.mdx | 4 +- .../messagessearchmodelsservertool.mdx | 4 +- .../messagesshelltoolresultblock.mdx | 10 +- .../messagesshelltoolresultblockfile.mdx | 12 +- docs/components/messagestooladditionblock.mdx | 6 +- ...stooladditionblocktoolmcptoolreference.mdx | 6 +- ...oladditionblocktoolmcptoolsetreference.mdx | 4 +- ...agestooladditionblocktooltoolreference.mdx | 4 +- docs/components/messagestoolremovalblock.mdx | 6 +- ...estoolremovalblocktoolmcptoolreference.mdx | 6 +- ...oolremovalblocktoolmcptoolsetreference.mdx | 4 +- ...sagestoolremovalblocktooltoolreference.mdx | 4 +- docs/components/mismatchbehavior.mdx | 2 +- docs/components/model.mdx | 40 +-- docs/components/modelaliastarget.mdx | 4 +- docs/components/modelarchitecture.mdx | 10 +- docs/components/modelbenchmarks.mdx | 4 +- docs/components/modellinks.mdx | 2 +- docs/components/modelreasoning.mdx | 10 +- docs/components/modelresponse.mdx | 2 +- docs/components/modelscountresponse.mdx | 2 +- docs/components/modelscountresponsedata.mdx | 2 +- docs/components/modelslistresponse.mdx | 6 +- docs/components/modelslistresponselinks.mdx | 2 +- docs/components/moderationplugin.mdx | 2 +- docs/components/multimodalmedia.mdx | 4 +- docs/components/namespacefunctiontool.mdx | 18 +- docs/components/namespacetool.mdx | 8 +- docs/components/nativesupport.mdx | 6 +- docs/components/nativetools.mdx | 2 +- docs/components/never.mdx | 2 +- docs/components/notfoundresponseerrordata.mdx | 6 +- docs/components/oauthjwks.mdx | 2 +- .../observabilityarizedestination.mdx | 34 +- .../observabilityarizedestinationconfig.mdx | 10 +- .../observabilitybraintrustdestination.mdx | 34 +- ...servabilitybraintrustdestinationconfig.mdx | 8 +- .../observabilityclickhousedestination.mdx | 34 +- ...servabilityclickhousedestinationconfig.mdx | 14 +- .../observabilitydatadogdestination.mdx | 34 +- .../observabilitydatadogdestinationconfig.mdx | 8 +- .../observabilityfilterrulegroup.mdx | 4 +- .../observabilityfilterrulesconfig.mdx | 4 +- ...observabilityfilterrulesconfignullable.mdx | 4 +- .../observabilitygrafanadestination.mdx | 34 +- .../observabilitygrafanadestinationconfig.mdx | 8 +- .../observabilitylangfusedestination.mdx | 34 +- ...observabilitylangfusedestinationconfig.mdx | 8 +- .../observabilitylangsmithdestination.mdx | 34 +- ...bservabilitylangsmithdestinationconfig.mdx | 10 +- .../observabilitynewrelicdestination.mdx | 34 +- ...observabilitynewrelicdestinationconfig.mdx | 6 +- .../observabilityopikdestination.mdx | 34 +- .../observabilityopikdestinationconfig.mdx | 8 +- .../observabilityotelcollectordestination.mdx | 34 +- ...vabilityotelcollectordestinationconfig.mdx | 4 +- .../observabilityposthogdestination.mdx | 34 +- .../observabilityposthogdestinationconfig.mdx | 6 +- .../observabilityrampdestination.mdx | 34 +- .../observabilityrampdestinationconfig.mdx | 6 +- .../components/observabilitys3destination.mdx | 34 +- .../observabilitys3destinationconfig.mdx | 18 +- .../observabilitysentrydestination.mdx | 34 +- .../observabilitysentrydestinationconfig.mdx | 6 +- .../observabilitysnowflakedestination.mdx | 34 +- ...bservabilitysnowflakedestinationconfig.mdx | 16 +- .../observabilityweavedestination.mdx | 34 +- .../observabilityweavedestinationconfig.mdx | 10 +- .../observabilitywebhookdestination.mdx | 34 +- .../observabilitywebhookdestinationconfig.mdx | 6 +- docs/components/openaifile.mdx | 16 +- docs/components/openaifiledeleted.mdx | 8 +- docs/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 +- docs/components/openairesponsestoolchoice.mdx | 2 +- .../openairesponsestoolchoiceapplypatch.mdx | 2 +- .../openairesponsestoolchoicefunction.mdx | 4 +- .../openairesponsestoolchoiceshell.mdx | 2 +- docs/components/openresponsescreatedevent.mdx | 6 +- docs/components/openresponseserrorfield.mdx | 6 +- .../components/openresponseserrormetadata.mdx | 2 +- .../openresponseserrormetadataalignment.mdx | 4 +- .../openresponsesinprogressevent.mdx | 6 +- docs/components/openresponsesresult.mdx | 76 ++--- .../openresponsesresulttoolfunction.mdx | 18 +- docs/components/openrouterfile.mdx | 16 +- docs/components/openrouterfiledeleted.mdx | 6 +- docs/components/openrouterfilelist.mdx | 12 +- docs/components/openroutermetadata.mdx | 22 +- .../openrouterwebsearchservertool.mdx | 4 +- docs/components/oranthropicbashtoolresult.mdx | 10 +- .../oranthropicbashtoolresultfile.mdx | 12 +- .../oranthropicservertooluseblock.mdx | 10 +- .../components/oranthropicshelltoolresult.mdx | 10 +- .../oranthropicshelltoolresultfile.mdx | 12 +- .../oranthropictoolsearchresult.mdx | 6 +- .../oranthropictoolsearchresultparam.mdx | 6 +- docs/components/organizationsettings.mdx | 4 +- docs/components/outcomeexit.mdx | 6 +- docs/components/outcometimeout.mdx | 4 +- .../outputadvisorservertoolitem.mdx | 16 +- docs/components/outputapplypatchcallitem.mdx | 10 +- .../outputapplypatchservertoolitem.mdx | 12 +- docs/components/outputarmorblockeditem.mdx | 18 +- docs/components/outputbashservertoolitem.mdx | 24 +- .../outputbashservertoolitemfile.mdx | 12 +- .../outputbrowseruseservertoolitem.mdx | 10 +- .../outputcodeinterpretercallitem.mdx | 14 +- .../outputcodeinterpreterservertoolitem.mdx | 16 +- docs/components/outputcomputercallitem.mdx | 12 +- docs/components/outputcustomtoolcallitem.mdx | 16 +- docs/components/outputdatetimeitem.mdx | 12 +- docs/components/outputfilesearchcallitem.mdx | 8 +- .../outputfilesearchservertoolitem.mdx | 8 +- docs/components/outputfilesservertoolitem.mdx | 20 +- docs/components/outputfunctioncallitem.mdx | 20 +- .../outputfunctioncallitemsubagentitem.mdx | 4 +- .../components/outputfusionservertoolitem.mdx | 18 +- .../outputfusionservertoolitemresponse.mdx | 4 +- .../outputimagegenerationcallitem.mdx | 10 +- .../outputimagegenerationservertoolitem.mdx | 18 +- docs/components/outputitemapplypatchcall.mdx | 12 +- .../outputitemcodeinterpretercall.mdx | 14 +- docs/components/outputitemcustomtoolcall.mdx | 16 +- docs/components/outputitemfilesearchcall.mdx | 8 +- docs/components/outputitemfunctioncall.mdx | 16 +- .../outputitemimagegenerationcall.mdx | 8 +- docs/components/outputitemreasoning.mdx | 12 +- docs/components/outputitemwebsearchcall.mdx | 10 +- ...utputitemwebsearchcallactionfindinpage.mdx | 6 +- .../outputitemwebsearchcallactionopenpage.mdx | 4 +- .../outputitemwebsearchcallactionsearch.mdx | 8 +- docs/components/outputmcpservertoolitem.mdx | 10 +- .../components/outputmemoryservertoolitem.mdx | 12 +- docs/components/outputmessage.mdx | 12 +- docs/components/outputmessageitem.mdx | 12 +- docs/components/outputreasoningitem.mdx | 16 +- .../outputsearchmodelsservertoolitem.mdx | 12 +- docs/components/outputshellcallitem.mdx | 12 +- docs/components/outputshellcallitemaction.mdx | 6 +- docs/components/outputshellcalloutputitem.mdx | 18 +- .../outputshellcalloutputitemfile.mdx | 12 +- docs/components/outputshellservertoolitem.mdx | 20 +- .../outputshellservertoolitemaction.mdx | 6 +- .../outputshellservertoolitemfile.mdx | 12 +- .../outputsubagentservertoolitem.mdx | 22 +- .../outputtexteditorservertoolitem.mdx | 10 +- docs/components/outputtokensdetails.mdx | 2 +- docs/components/outputtoolsearchcallitem.mdx | 12 +- .../outputtoolsearchservertoolitem.mdx | 12 +- .../outputwebfetchservertoolitem.mdx | 16 +- docs/components/outputwebsearchcallitem.mdx | 10 +- ...utputwebsearchcallitemactionfindinpage.mdx | 6 +- .../outputwebsearchcallitemactionopenpage.mdx | 4 +- .../outputwebsearchcallitemactionsearch.mdx | 8 +- .../outputwebsearchservertoolitem.mdx | 10 +- .../outputwebsearchservertoolitemaction.mdx | 6 +- .../outputwebsearchservertoolitemsource.mdx | 4 +- docs/components/paretorouterplugin.mdx | 10 +- docs/components/partialcoverage.mdx | 4 +- .../payloadtoolargeresponseerrordata.mdx | 6 +- .../paymentrequiredresponseerrordata.mdx | 6 +- docs/components/pdfparseroptions.mdx | 2 +- docs/components/pendingsafetycheck.mdx | 6 +- docs/components/percentilelatencycutoffs.mdx | 8 +- docs/components/percentilestats.mdx | 8 +- .../percentilethroughputcutoffs.mdx | 8 +- docs/components/perflast30mbyworkload.mdx | 18 +- docs/components/perrequestlimits.mdx | 4 +- docs/components/pipelinestage.mdx | 14 +- docs/components/prediction.mdx | 4 +- docs/components/predictioncontenttext.mdx | 4 +- docs/components/preset.mdx | 22 +- docs/components/presetdesignatedversion.mdx | 16 +- .../presetwithdesignatedversion.mdx | 24 +- .../preview20250311websearchservertool.mdx | 18 +- .../components/previewwebsearchservertool.mdx | 18 +- .../previewwebsearchuserlocation.mdx | 10 +- docs/components/pricing.mdx | 32 +- docs/components/pricingoverride.mdx | 22 +- docs/components/privateendpoint.mdx | 24 +- docs/components/privateendpointactivation.mdx | 2 +- docs/components/privateendpointcheck.mdx | 12 +- docs/components/privateendpointpricing.mdx | 4 +- docs/components/privateendpointresponse.mdx | 2 +- docs/components/privateendpointsummary.mdx | 14 +- docs/components/privateendpointvalidation.mdx | 4 +- .../privateendpointvalidationnullable.mdx | 4 +- .../privateendpointvalidationresponse.mdx | 2 +- docs/components/progress.mdx | 6 +- docs/components/promptcachebreakpoint.mdx | 2 +- docs/components/promptcacheoptions.mdx | 4 +- docs/components/provideroptions.mdx | 292 ++++++++--------- .../provideroverloadedresponseerrordata.mdx | 6 +- docs/components/providerpreferences.mdx | 28 +- docs/components/providerresponse.mdx | 16 +- docs/components/providersortconfig.mdx | 4 +- docs/components/provisioninternresponse.mdx | 2 +- docs/components/publicendpoint.mdx | 48 +-- docs/components/publicpricing.mdx | 32 +- docs/components/rangecapability.mdx | 6 +- docs/components/rankingoptions.mdx | 4 +- docs/components/rankingsdailyitem.mdx | 6 +- docs/components/rankingsdailymeta.mdx | 8 +- docs/components/rankingsdailyresponse.mdx | 4 +- docs/components/reasoningconfig.mdx | 12 +- docs/components/reasoningdeltaevent.mdx | 12 +- docs/components/reasoningdetailencrypted.mdx | 10 +- .../reasoningdetailservertoolcall.mdx | 16 +- docs/components/reasoningdetailsummary.mdx | 10 +- docs/components/reasoningdetailtext.mdx | 12 +- docs/components/reasoningdoneevent.mdx | 12 +- docs/components/reasoningitem.mdx | 16 +- .../reasoningsummarypartaddedevent.mdx | 12 +- .../reasoningsummarypartdoneevent.mdx | 12 +- docs/components/reasoningsummarytext.mdx | 4 +- .../reasoningsummarytextdeltaevent.mdx | 12 +- .../reasoningsummarytextdoneevent.mdx | 12 +- docs/components/reasoningtextcontent.mdx | 4 +- docs/components/refusal.mdx | 8 +- docs/components/refusaldeltaevent.mdx | 12 +- docs/components/refusaldoneevent.mdx | 12 +- docs/components/refusaltoplogprob.mdx | 6 +- docs/components/request.mdx | 4 +- .../requesttimeoutresponseerrordata.mdx | 6 +- docs/components/requireapproval.mdx | 4 +- docs/components/rerank.mdx | 6 +- docs/components/responsehealingplugin.mdx | 4 +- docs/components/responseoutputtext.mdx | 8 +- .../responseoutputtexttoplogprob.mdx | 6 +- docs/components/responsesrequest.mdx | 80 ++--- .../responsesrequesttoolfunction.mdx | 18 +- .../components/responsesstreamingresponse.mdx | 2 +- docs/components/result.mdx | 8 +- docs/components/resulterror.mdx | 8 +- docs/components/routerattempt.mdx | 6 +- docs/components/routerparams.mdx | 8 +- docs/components/rule.mdx | 6 +- docs/components/scimgroup.mdx | 12 +- docs/components/scimgroupmapping.mdx | 14 +- docs/components/scimsyncjob.mdx | 16 +- .../searchmodelsservertoolconfig.mdx | 2 +- .../searchmodelsservertoolopenrouter.mdx | 4 +- docs/components/security.mdx | 2 +- docs/components/servertool.mdx | 30 +- docs/components/servertooldetails.mdx | 30 +- docs/components/servertoolengine.mdx | 18 +- docs/components/servertoolinputname.mdx | 6 +- docs/components/servertoolnativemodel.mdx | 4 +- docs/components/servertoolnativesupport.mdx | 4 +- docs/components/servertooloutputname.mdx | 6 +- docs/components/servertoolprice.mdx | 8 +- docs/components/servertoolusedetails.mdx | 6 +- .../serviceunavailableresponseerrordata.mdx | 6 +- docs/components/sessioncostitem.mdx | 10 +- docs/components/sessioncostmeta.mdx | 8 +- docs/components/sessioncostresponse.mdx | 4 +- docs/components/shellcallitem.mdx | 14 +- docs/components/shellcallitemaction.mdx | 6 +- docs/components/shellcalloutputcontent.mdx | 8 +- docs/components/shellcalloutputitem.mdx | 18 +- docs/components/shellcalloutputitemfile.mdx | 12 +- docs/components/shellservertool.mdx | 2 +- docs/components/shellservertoolconfig.mdx | 4 +- docs/components/shellservertoolopenrouter.mdx | 4 +- docs/components/signinterndaemonrequest.mdx | 2 +- docs/components/signinterndaemonresponse.mdx | 6 +- docs/components/sourcecontent.mdx | 4 +- docs/components/speechinputreferenceaudio.mdx | 4 +- .../speechinputreferenceaudioinput.mdx | 6 +- docs/components/speechinputreferenceimage.mdx | 4 +- .../speechinputreferenceimageinput.mdx | 2 +- docs/components/speechinputreferencetext.mdx | 4 +- docs/components/speechrequest.mdx | 22 +- docs/components/speechrequestprovider.mdx | 6 +- docs/components/speechturn.mdx | 6 +- docs/components/stance.mdx | 4 +- .../stopservertoolswhenfinishreasonis.mdx | 4 +- .../stopservertoolswhenhastoolcall.mdx | 4 +- .../components/stopservertoolswhenmaxcost.mdx | 4 +- .../stopservertoolswhenmaxtokensused.mdx | 4 +- .../stopservertoolswhenstepcountis.mdx | 4 +- docs/components/storedprompttemplate.mdx | 4 +- .../streameventsresponsecompleted.mdx | 6 +- .../components/streameventsresponsefailed.mdx | 6 +- .../streameventsresponseincomplete.mdx | 6 +- .../streameventsresponseoutputitemadded.mdx | 8 +- .../streameventsresponseoutputitemdone.mdx | 8 +- docs/components/streamlogprob.mdx | 8 +- docs/components/streamlogprobtoplogprob.mdx | 6 +- docs/components/stt.mdx | 6 +- docs/components/sttentity.mdx | 8 +- docs/components/sttinlineinputaudio.mdx | 4 +- docs/components/sttrequest.mdx | 24 +- docs/components/sttrequestprovider.mdx | 6 +- docs/components/sttresponse.mdx | 20 +- docs/components/sttsegment.mdx | 26 +- docs/components/stturlinputaudio.mdx | 4 +- docs/components/sttusage.mdx | 10 +- docs/components/sttword.mdx | 16 +- docs/components/subagentnestedtool.mdx | 6 +- docs/components/subagentreasoning.mdx | 4 +- docs/components/subagentservertoolconfig.mdx | 20 +- .../subagentservertoolopenrouter.mdx | 4 +- .../submitgenerationfeedbackrequest.mdx | 6 +- .../submitgenerationfeedbackresponse.mdx | 2 +- .../submitgenerationfeedbackresponsedata.mdx | 2 +- docs/components/suspendinternresponse.mdx | 2 +- docs/components/switchyardrouterplugin.mdx | 6 +- docs/components/taskbudget.mdx | 6 +- docs/components/taskclassificationitem.mdx | 16 +- .../taskclassificationmacrocategory.mdx | 8 +- docs/components/taskclassificationmodel.mdx | 6 +- .../components/taskclassificationresponse.mdx | 2 +- .../taskclassificationresponsedata.mdx | 8 +- docs/components/textdeltaevent.mdx | 14 +- docs/components/textdoneevent.mdx | 14 +- docs/components/textextendedconfig.mdx | 4 +- docs/components/textgeneration.mdx | 6 +- docs/components/thinkingadaptive.mdx | 6 +- docs/components/thinkingbetweentools.mdx | 2 +- docs/components/thinkingdisabled.mdx | 2 +- docs/components/thinkingenabled.mdx | 8 +- docs/components/tokenexchangerequest.mdx | 12 +- docs/components/tokenexchangeresponse.mdx | 10 +- docs/components/tooladvisor20260301.mdx | 16 +- docs/components/toolbash20250124.mdx | 6 +- docs/components/toolcall.mdx | 8 +- docs/components/toolchoiceallowed.mdx | 6 +- docs/components/toolchoiceany.mdx | 4 +- docs/components/toolchoiceauto.mdx | 4 +- docs/components/toolchoicenone.mdx | 2 +- docs/components/toolchoicesupport.mdx | 8 +- docs/components/toolchoicetool.mdx | 6 +- docs/components/toolcustom.mdx | 14 +- docs/components/toolsearchcallitem.mdx | 12 +- docs/components/toolsearchoutputitem.mdx | 12 +- docs/components/toolsearchoutputitemtool.mdx | 4 +- .../toolsearchoutputitemtoolfunction.mdx | 18 +- docs/components/toolsearchservertool.mdx | 4 +- .../components/toolsearchservertoolconfig.mdx | 2 +- docs/components/tooltexteditor20250124.mdx | 6 +- docs/components/toolwebsearch20250305.mdx | 14 +- docs/components/toolwebsearch20260209.mdx | 16 +- .../toomanyrequestsresponseerrordata.mdx | 6 +- docs/components/topproviderinfo.mdx | 6 +- docs/components/tournamentstats.mdx | 10 +- docs/components/traceconfig.mdx | 12 +- docs/components/triggerinputtokens.mdx | 4 +- docs/components/tts.mdx | 6 +- .../unauthorizedresponseerrordata.mdx | 6 +- docs/components/unifiedbenchmarkpricing.mdx | 4 +- docs/components/unifiedbenchmarksaaitem.mdx | 14 +- docs/components/unifiedbenchmarksdaitem.mdx | 20 +- docs/components/unifiedbenchmarksmeta.mdx | 14 +- docs/components/unifiedbenchmarksoritem.mdx | 18 +- docs/components/unifiedbenchmarksresponse.mdx | 4 +- .../unifiedbenchmarkssearchitem.mdx | 26 +- .../unifiedbenchmarkssearchrunconfig.mdx | 6 +- docs/components/uniqueinsight.mdx | 4 +- docs/components/unknown.mdx | 6 +- .../unprocessableentityresponseerrordata.mdx | 6 +- docs/components/updatebyokkeyrequest.mdx | 22 +- docs/components/updatebyokkeyresponse.mdx | 2 +- docs/components/updateenduserrequest.mdx | 2 +- docs/components/updateguardrailrequest.mdx | 44 +-- docs/components/updateguardrailresponse.mdx | 2 +- docs/components/updateinternrequest.mdx | 8 +- .../updateobservabilitydestinationrequest.mdx | 24 +- ...updateobservabilitydestinationresponse.mdx | 2 +- .../updateorganizationsettingsrequest.mdx | 2 +- .../updateprivateendpointpricingrequest.mdx | 2 +- .../updateprivateendpointrequest.mdx | 8 +- .../updatescimgroupmappingrequest.mdx | 2 +- .../updatescimgroupmappingresponse.mdx | 2 +- docs/components/updateworkspacerequest.mdx | 24 +- docs/components/updateworkspaceresponse.mdx | 2 +- docs/components/upscalefactor.mdx | 4 +- .../upsertworkspacebudgetrequest.mdx | 4 +- .../upsertworkspacebudgetresponse.mdx | 4 +- docs/components/upstream.mdx | 4 +- docs/components/urlcitation.mdx | 12 +- docs/components/usage.mdx | 18 +- docs/components/usagecostdetails.mdx | 8 +- docs/components/userlocation.mdx | 10 +- .../validateprivateendpointrequest.mdx | 2 +- docs/components/vaulteffectivesecret.mdx | 10 +- .../vaulteffectivesecretlistresponse.mdx | 4 +- docs/components/vaultsecret.mdx | 8 +- docs/components/vaultsecretcopyrequest.mdx | 2 +- docs/components/vaultsecretcopyresponse.mdx | 2 +- docs/components/vaultsecretlistresponse.mdx | 4 +- docs/components/vaultsecretresponse.mdx | 2 +- docs/components/vaultsecretwriterequest.mdx | 4 +- docs/components/videogeneration.mdx | 6 +- docs/components/videogenerationrequest.mdx | 36 +-- .../videogenerationrequestoptions.mdx | 292 ++++++++--------- .../videogenerationrequestprovider.mdx | 2 +- docs/components/videogenerationresponse.mdx | 16 +- docs/components/videogenerationusage.mdx | 4 +- docs/components/videomodel.mdx | 34 +- docs/components/videomodelslistresponse.mdx | 2 +- docs/components/videourl.mdx | 2 +- docs/components/webfetchplugin.mdx | 10 +- docs/components/webfetchservertool.mdx | 4 +- docs/components/webfetchservertoolconfig.mdx | 10 +- .../websearchcallcompletedevent.mdx | 8 +- .../websearchcallinprogressevent.mdx | 8 +- .../websearchcallsearchingevent.mdx | 8 +- docs/components/websearchcitation.mdx | 8 +- docs/components/websearchconfig.mdx | 22 +- docs/components/websearchdomainfilter.mdx | 6 +- docs/components/websearchplugin.mdx | 22 +- docs/components/websearchservertool.mdx | 18 +- docs/components/websearchservertoolconfig.mdx | 22 +- .../websearchservertoolopenrouter.mdx | 4 +- docs/components/websearchsource.mdx | 4 +- docs/components/websearchuserlocation.mdx | 10 +- .../websearchuserlocationservertool.mdx | 10 +- docs/components/workspace.mdx | 36 +-- docs/components/workspacebudget.mdx | 12 +- docs/components/workspacemember.mdx | 10 +- docs/components/xsearchoptions.mdx | 12 +- docs/errors/badgatewayresponseerror.mdx | 6 +- docs/errors/badrequestresponseerror.mdx | 6 +- docs/errors/batcherrorresponse.mdx | 2 +- .../batchpaymentrequiredresponseerror.mdx | 24 +- docs/errors/conflictresponseerror.mdx | 6 +- ...eendpointvalidationfailedresponseerror.mdx | 4 +- .../edgenetworktimeoutresponseerror.mdx | 6 +- docs/errors/forbiddenresponseerror.mdx | 6 +- docs/errors/gatewaytimeoutresponseerror.mdx | 6 +- docs/errors/goneresponseerror.mdx | 6 +- docs/errors/internalserverresponseerror.mdx | 6 +- docs/errors/internchaterrorresponse.mdx | 2 +- docs/errors/internlifecycleerror.mdx | 2 +- docs/errors/notfoundresponseerror.mdx | 6 +- docs/errors/oautherrorresponse.mdx | 4 +- docs/errors/payloadtoolargeresponseerror.mdx | 6 +- docs/errors/paymentrequiredresponseerror.mdx | 6 +- .../provideroverloadedresponseerror.mdx | 6 +- docs/errors/requesttimeoutresponseerror.mdx | 6 +- .../serviceunavailableresponseerror.mdx | 6 +- docs/errors/toomanyrequestsresponseerror.mdx | 6 +- docs/errors/unauthorizedresponseerror.mdx | 6 +- .../unprocessableentityresponseerror.mdx | 6 +- docs/models/internal/globals.mdx | 6 +- .../activateprivateendpointglobals.mdx | 6 +- .../activateprivateendpointrequest.mdx | 8 +- .../bulkaddworkspacemembersglobals.mdx | 6 +- .../bulkaddworkspacemembersrequest.mdx | 10 +- .../bulkassignkeystoguardrailglobals.mdx | 6 +- .../bulkassignkeystoguardrailrequest.mdx | 10 +- .../bulkassignmemberstoguardrailglobals.mdx | 6 +- .../bulkassignmemberstoguardrailrequest.mdx | 10 +- .../bulkremoveworkspacemembersglobals.mdx | 6 +- .../bulkremoveworkspacemembersrequest.mdx | 10 +- .../bulkunassignkeysfromguardrailglobals.mdx | 6 +- .../bulkunassignkeysfromguardrailrequest.mdx | 10 +- ...ulkunassignmembersfromguardrailglobals.mdx | 6 +- ...ulkunassignmembersfromguardrailrequest.mdx | 10 +- docs/operations/classifierdimensions.mdx | 6 +- docs/operations/classifierfilters.mdx | 4 +- docs/operations/classifierfiltersfilter.mdx | 6 +- docs/operations/contentimageurl.mdx | 4 +- docs/operations/contenttext.mdx | 4 +- .../copyvaultsecretstointernglobals.mdx | 6 +- .../copyvaultsecretstointernrequest.mdx | 10 +- .../createapialphadecisionsglobals.mdx | 6 +- .../createapialphadecisionsrequest.mdx | 8 +- docs/operations/createaudiospeechglobals.mdx | 6 +- docs/operations/createaudiospeechrequest.mdx | 8 +- .../createaudiotranscriptionsglobals.mdx | 6 +- ...createaudiotranscriptionsmultipartfile.mdx | 6 +- ...ateaudiotranscriptionsmultipartglobals.mdx | 6 +- ...ateaudiotranscriptionsmultipartrequest.mdx | 8 +- ...udiotranscriptionsmultipartrequestbody.mdx | 26 +- .../createaudiotranscriptionsrequest.mdx | 8 +- docs/operations/createauthkeyscodedata.mdx | 6 +- docs/operations/createauthkeyscodeglobals.mdx | 6 +- docs/operations/createauthkeyscoderequest.mdx | 8 +- .../createauthkeyscoderequestbody.mdx | 16 +- .../operations/createauthkeyscoderesponse.mdx | 2 +- docs/operations/createbatchesglobals.mdx | 6 +- docs/operations/createbatchesrequest.mdx | 8 +- docs/operations/createbyokkeyglobals.mdx | 6 +- docs/operations/createbyokkeyrequest.mdx | 8 +- docs/operations/createembeddingsdata.mdx | 6 +- docs/operations/createembeddingsglobals.mdx | 6 +- docs/operations/createembeddingsrequest.mdx | 8 +- .../createembeddingsrequestbody.mdx | 18 +- .../createembeddingsresponsebody.mdx | 10 +- docs/operations/createembeddingsusage.mdx | 12 +- docs/operations/createenduserglobals.mdx | 6 +- docs/operations/createenduserrequest.mdx | 8 +- docs/operations/createguardrailglobals.mdx | 6 +- docs/operations/createguardrailrequest.mdx | 8 +- docs/operations/createimagesglobals.mdx | 6 +- docs/operations/createimagesrequest.mdx | 8 +- .../createinternchatcompletionglobals.mdx | 6 +- .../createinternchatcompletionrequest.mdx | 10 +- .../createinternchatcompletionresponse.mdx | 4 +- docs/operations/createinternglobals.mdx | 6 +- docs/operations/createinternrequest.mdx | 10 +- docs/operations/createkeysdata.mdx | 46 +-- docs/operations/createkeysglobals.mdx | 6 +- docs/operations/createkeysrequest.mdx | 8 +- docs/operations/createkeysrequestbody.mdx | 16 +- docs/operations/createkeysresponse.mdx | 4 +- docs/operations/createoauthtokenglobals.mdx | 6 +- docs/operations/createoauthtokenrequest.mdx | 8 +- .../createobservabilitydestinationglobals.mdx | 6 +- .../createobservabilitydestinationrequest.mdx | 8 +- .../createpresetschatcompletionsglobals.mdx | 6 +- .../createpresetschatcompletionsrequest.mdx | 10 +- .../createpresetsmessagesglobals.mdx | 6 +- .../createpresetsmessagesrequest.mdx | 10 +- .../createpresetsresponsesglobals.mdx | 6 +- .../createpresetsresponsesrequest.mdx | 10 +- .../createprivateendpointglobals.mdx | 6 +- .../createprivateendpointrequest.mdx | 10 +- docs/operations/creatererankglobals.mdx | 6 +- docs/operations/creatererankrequest.mdx | 8 +- docs/operations/creatererankrequestbody.mdx | 16 +- docs/operations/creatererankresponsebody.mdx | 10 +- docs/operations/creatererankusage.mdx | 6 +- docs/operations/createresponsesglobals.mdx | 6 +- docs/operations/createresponsesrequest.mdx | 10 +- .../createscimgroupmappingglobals.mdx | 6 +- .../createscimgroupmappingrequest.mdx | 8 +- docs/operations/createscimsyncjobglobals.mdx | 6 +- docs/operations/createscimsyncjobrequest.mdx | 6 +- docs/operations/createscimsyncjobresponse.mdx | 4 +- docs/operations/createsystemoneglobals.mdx | 6 +- docs/operations/createsystemonerequest.mdx | 8 +- docs/operations/createvideosglobals.mdx | 6 +- docs/operations/createvideosrequest.mdx | 8 +- docs/operations/createworkspaceglobals.mdx | 6 +- docs/operations/createworkspacerequest.mdx | 8 +- docs/operations/deletebatchglobals.mdx | 6 +- docs/operations/deletebatchrequest.mdx | 8 +- docs/operations/deletebyokkeyglobals.mdx | 6 +- docs/operations/deletebyokkeyrequest.mdx | 8 +- docs/operations/deleteenduserglobals.mdx | 6 +- docs/operations/deleteenduserrequest.mdx | 8 +- docs/operations/deletefileglobals.mdx | 6 +- docs/operations/deletefilerequest.mdx | 12 +- docs/operations/deleteguardrailglobals.mdx | 6 +- docs/operations/deleteguardrailrequest.mdx | 8 +- docs/operations/deleteinternglobals.mdx | 6 +- docs/operations/deleteinternrequest.mdx | 10 +- .../deleteinternvaultsecretglobals.mdx | 6 +- .../deleteinternvaultsecretrequest.mdx | 10 +- docs/operations/deletekeysglobals.mdx | 6 +- docs/operations/deletekeysrequest.mdx | 8 +- docs/operations/deletekeysresponse.mdx | 2 +- .../deleteobservabilitydestinationglobals.mdx | 6 +- .../deleteobservabilitydestinationrequest.mdx | 8 +- .../deleteprivateendpointglobals.mdx | 6 +- .../deleteprivateendpointrequest.mdx | 10 +- .../deletescimgroupmappingglobals.mdx | 6 +- .../deletescimgroupmappingrequest.mdx | 10 +- docs/operations/deletevaultsecretglobals.mdx | 6 +- docs/operations/deletevaultsecretrequest.mdx | 8 +- .../deleteworkspacebudgetglobals.mdx | 6 +- .../deleteworkspacebudgetrequest.mdx | 10 +- docs/operations/deleteworkspaceglobals.mdx | 6 +- docs/operations/deleteworkspacerequest.mdx | 10 +- docs/operations/dimension.mdx | 4 +- .../disableprivateendpointglobals.mdx | 6 +- .../disableprivateendpointrequest.mdx | 8 +- docs/operations/documentrequest.mdx | 4 +- docs/operations/documentresponse.mdx | 4 +- .../downloadcontainerfilecontentglobals.mdx | 6 +- .../downloadcontainerfilecontentrequest.mdx | 10 +- .../operations/downloadfilecontentglobals.mdx | 6 +- .../operations/downloadfilecontentrequest.mdx | 12 +- .../enableprivateendpointglobals.mdx | 6 +- .../enableprivateendpointrequest.mdx | 8 +- .../exchangeauthcodeforapikeyglobals.mdx | 6 +- .../exchangeauthcodeforapikeyrequest.mdx | 8 +- .../exchangeauthcodeforapikeyrequestbody.mdx | 6 +- .../exchangeauthcodeforapikeyresponse.mdx | 4 +- docs/operations/external.mdx | 4 +- docs/operations/filter_.mdx | 8 +- docs/operations/getanalyticsmetadata.mdx | 8 +- docs/operations/getanalyticsmetaglobals.mdx | 6 +- docs/operations/getanalyticsmetarequest.mdx | 6 +- docs/operations/getanalyticsmetaresponse.mdx | 2 +- docs/operations/getapprankingsglobals.mdx | 6 +- docs/operations/getapprankingsrequest.mdx | 20 +- docs/operations/getapprankingsresponse.mdx | 2 +- docs/operations/getbatchesglobals.mdx | 6 +- docs/operations/getbatchesrequest.mdx | 8 +- docs/operations/getbenchmarksglobals.mdx | 6 +- docs/operations/getbenchmarksrequest.mdx | 24 +- docs/operations/getbyokkeyglobals.mdx | 6 +- docs/operations/getbyokkeyrequest.mdx | 8 +- docs/operations/getcontainerfileglobals.mdx | 6 +- docs/operations/getcontainerfilerequest.mdx | 10 +- docs/operations/getcreditsdata.mdx | 4 +- docs/operations/getcreditsglobals.mdx | 6 +- docs/operations/getcreditsrequest.mdx | 6 +- docs/operations/getcreditsresponse.mdx | 2 +- docs/operations/getcurrentkeydata.mdx | 50 +-- docs/operations/getcurrentkeyglobals.mdx | 6 +- docs/operations/getcurrentkeyrequest.mdx | 6 +- docs/operations/getcurrentkeyresponse.mdx | 2 +- docs/operations/getenduserglobals.mdx | 6 +- docs/operations/getenduserrequest.mdx | 8 +- docs/operations/getfilemetadataglobals.mdx | 6 +- docs/operations/getfilemetadatarequest.mdx | 12 +- docs/operations/getgenerationglobals.mdx | 6 +- docs/operations/getgenerationrequest.mdx | 8 +- docs/operations/getguardrailglobals.mdx | 6 +- docs/operations/getguardrailrequest.mdx | 8 +- .../getinterndaemonaccessglobals.mdx | 6 +- .../getinterndaemonaccessrequest.mdx | 8 +- docs/operations/getinterndaemonglobals.mdx | 6 +- docs/operations/getinterndaemonrequest.mdx | 8 +- docs/operations/getinternglobals.mdx | 6 +- docs/operations/getinternrequest.mdx | 8 +- docs/operations/getkeydata.mdx | 46 +-- docs/operations/getkeyglobals.mdx | 6 +- docs/operations/getkeyrequest.mdx | 8 +- docs/operations/getkeyresponse.mdx | 2 +- docs/operations/getmodelglobals.mdx | 6 +- docs/operations/getmodelrequest.mdx | 10 +- docs/operations/getmodelsglobals.mdx | 6 +- docs/operations/getmodelsrequest.mdx | 64 ++-- docs/operations/getmodelsresponse.mdx | 2 +- .../getobservabilitydestinationglobals.mdx | 6 +- .../getobservabilitydestinationrequest.mdx | 8 +- .../getorganizationsettingsglobals.mdx | 6 +- .../getorganizationsettingsrequest.mdx | 6 +- .../getorganizationsettingsresponse.mdx | 2 +- docs/operations/getpresetglobals.mdx | 6 +- docs/operations/getpresetrequest.mdx | 8 +- docs/operations/getpresetversionglobals.mdx | 6 +- docs/operations/getpresetversionrequest.mdx | 10 +- docs/operations/getprivateendpointglobals.mdx | 6 +- docs/operations/getprivateendpointrequest.mdx | 8 +- docs/operations/getrankingsdailyglobals.mdx | 6 +- docs/operations/getrankingsdailyrequest.mdx | 20 +- .../operations/getscimgroupmappingglobals.mdx | 6 +- .../operations/getscimgroupmappingrequest.mdx | 8 +- docs/operations/getscimsyncjobglobals.mdx | 6 +- docs/operations/getscimsyncjobrequest.mdx | 8 +- docs/operations/getsessioncostglobals.mdx | 6 +- docs/operations/getsessioncostrequest.mdx | 16 +- docs/operations/getsessioncostresponse.mdx | 2 +- .../gettaskclassificationsglobals.mdx | 6 +- .../gettaskclassificationsrequest.mdx | 8 +- docs/operations/gettoolglobals.mdx | 6 +- docs/operations/gettoolrequest.mdx | 8 +- docs/operations/gettoolresponse.mdx | 4 +- docs/operations/gettoolsecurity.mdx | 2 +- docs/operations/getuseractivityglobals.mdx | 6 +- docs/operations/getuseractivityrequest.mdx | 16 +- docs/operations/getvideosglobals.mdx | 6 +- docs/operations/getvideosrequest.mdx | 8 +- docs/operations/getworkspacebudgetglobals.mdx | 6 +- docs/operations/getworkspacebudgetrequest.mdx | 10 +- docs/operations/getworkspaceglobals.mdx | 6 +- docs/operations/getworkspacerequest.mdx | 8 +- docs/operations/granularity.mdx | 4 +- docs/operations/imageurl.mdx | 2 +- docs/operations/input.mdx | 2 +- docs/operations/invokeinternglobals.mdx | 6 +- docs/operations/invokeinternrequest.mdx | 10 +- docs/operations/invokeinternresponse.mdx | 4 +- docs/operations/listbatchesglobals.mdx | 6 +- docs/operations/listbatchesrequest.mdx | 16 +- docs/operations/listbatchesresponse.mdx | 2 +- docs/operations/listbyokkeysglobals.mdx | 6 +- docs/operations/listbyokkeysrequest.mdx | 14 +- docs/operations/listbyokkeysresponse.mdx | 2 +- docs/operations/listcontainerfilesglobals.mdx | 6 +- docs/operations/listcontainerfilesrequest.mdx | 12 +- docs/operations/listdata.mdx | 46 +-- .../listembeddingsmodelsglobals.mdx | 6 +- .../listembeddingsmodelsrequest.mdx | 10 +- .../listembeddingsmodelsresponse.mdx | 2 +- docs/operations/listendpointsglobals.mdx | 6 +- docs/operations/listendpointsrequest.mdx | 10 +- docs/operations/listendpointsresponse.mdx | 2 +- docs/operations/listendpointszdrglobals.mdx | 6 +- docs/operations/listendpointszdrrequest.mdx | 6 +- docs/operations/listendpointszdrresponse.mdx | 2 +- docs/operations/listendusersglobals.mdx | 6 +- docs/operations/listendusersrequest.mdx | 14 +- docs/operations/listendusersresponse.mdx | 2 +- docs/operations/listfilesglobals.mdx | 6 +- docs/operations/listfilesrequest.mdx | 22 +- docs/operations/listfilesresponse.mdx | 2 +- .../listgenerationcontentglobals.mdx | 6 +- .../listgenerationcontentrequest.mdx | 8 +- docs/operations/listglobals.mdx | 6 +- .../listguardrailkeyassignmentsglobals.mdx | 6 +- .../listguardrailkeyassignmentsrequest.mdx | 12 +- .../listguardrailkeyassignmentsresponse.mdx | 2 +- .../listguardrailmemberassignmentsglobals.mdx | 6 +- .../listguardrailmemberassignmentsrequest.mdx | 12 +- ...listguardrailmemberassignmentsresponse.mdx | 2 +- docs/operations/listguardrailsglobals.mdx | 6 +- docs/operations/listguardrailsrequest.mdx | 12 +- docs/operations/listguardrailsresponse.mdx | 2 +- .../listimagemodelendpointsglobals.mdx | 6 +- .../listimagemodelendpointsrequest.mdx | 10 +- docs/operations/listimagemodelsglobals.mdx | 6 +- docs/operations/listimagemodelsrequest.mdx | 6 +- ...listinterneffectivevaultsecretsglobals.mdx | 6 +- ...listinterneffectivevaultsecretsrequest.mdx | 12 +- docs/operations/listinternsglobals.mdx | 6 +- docs/operations/listinternsrequest.mdx | 14 +- .../listinternvaultsecretsglobals.mdx | 6 +- .../listinternvaultsecretsrequest.mdx | 12 +- docs/operations/listkeyassignmentsglobals.mdx | 6 +- docs/operations/listkeyassignmentsrequest.mdx | 10 +- .../operations/listkeyassignmentsresponse.mdx | 2 +- .../listmemberassignmentsglobals.mdx | 6 +- .../listmemberassignmentsrequest.mdx | 10 +- .../listmemberassignmentsresponse.mdx | 2 +- docs/operations/listmodelscountglobals.mdx | 6 +- docs/operations/listmodelscountrequest.mdx | 8 +- docs/operations/listmodelsuserglobals.mdx | 6 +- docs/operations/listmodelsuserrequest.mdx | 12 +- docs/operations/listmodelsuserresponse.mdx | 2 +- docs/operations/listmodelsusersecurity.mdx | 2 +- docs/operations/listoauthjwksglobals.mdx | 6 +- docs/operations/listoauthjwksrequest.mdx | 6 +- .../listobservabilitydestinationsglobals.mdx | 6 +- .../listobservabilitydestinationsrequest.mdx | 12 +- .../listobservabilitydestinationsresponse.mdx | 2 +- .../listorganizationmembersdata.mdx | 10 +- .../listorganizationmembersglobals.mdx | 6 +- .../listorganizationmembersrequest.mdx | 10 +- .../listorganizationmembersresponse.mdx | 2 +- .../listorganizationmembersresponsebody.mdx | 4 +- docs/operations/listpresetsglobals.mdx | 6 +- docs/operations/listpresetsrequest.mdx | 10 +- docs/operations/listpresetsresponse.mdx | 2 +- docs/operations/listpresetversionsglobals.mdx | 6 +- docs/operations/listpresetversionsrequest.mdx | 12 +- .../operations/listpresetversionsresponse.mdx | 2 +- .../listprivateendpointsglobals.mdx | 6 +- .../listprivateendpointsrequest.mdx | 6 +- docs/operations/listprovidersdata.mdx | 14 +- docs/operations/listprovidersglobals.mdx | 6 +- docs/operations/listprovidersrequest.mdx | 6 +- docs/operations/listprovidersresponse.mdx | 2 +- docs/operations/listrequest.mdx | 14 +- docs/operations/listresponse.mdx | 2 +- .../listscimgroupmappingsglobals.mdx | 6 +- .../listscimgroupmappingsrequest.mdx | 10 +- .../listscimgroupmappingsresponse.mdx | 2 +- docs/operations/listscimgroupsglobals.mdx | 6 +- docs/operations/listscimgroupsrequest.mdx | 14 +- docs/operations/listscimgroupsresponse.mdx | 2 +- docs/operations/listtoolsglobals.mdx | 6 +- docs/operations/listtoolsrequest.mdx | 12 +- docs/operations/listtoolssecurity.mdx | 2 +- docs/operations/listvaultsecretsglobals.mdx | 6 +- docs/operations/listvaultsecretsrequest.mdx | 10 +- docs/operations/listvideoscontentglobals.mdx | 6 +- docs/operations/listvideoscontentrequest.mdx | 10 +- docs/operations/listvideosmodelsglobals.mdx | 6 +- docs/operations/listvideosmodelsrequest.mdx | 6 +- .../listworkspacebudgetsglobals.mdx | 6 +- .../listworkspacebudgetsrequest.mdx | 8 +- .../listworkspacemembersglobals.mdx | 6 +- .../listworkspacemembersrequest.mdx | 12 +- .../listworkspacemembersresponse.mdx | 2 +- docs/operations/listworkspacesglobals.mdx | 6 +- docs/operations/listworkspacesrequest.mdx | 10 +- docs/operations/listworkspacesresponse.mdx | 2 +- docs/operations/metadata.mdx | 6 +- docs/operations/metric.mdx | 8 +- docs/operations/operator.mdx | 4 +- docs/operations/orderby.mdx | 4 +- .../promotecontainerfileglobals.mdx | 6 +- .../promotecontainerfilerequest.mdx | 10 +- docs/operations/prompttokensdetails.mdx | 10 +- docs/operations/provisioninternglobals.mdx | 6 +- docs/operations/provisioninternrequest.mdx | 8 +- docs/operations/queryanalyticsdata2.mdx | 8 +- docs/operations/queryanalyticsglobals.mdx | 6 +- docs/operations/queryanalyticsrequest.mdx | 8 +- docs/operations/queryanalyticsrequestbody.mdx | 20 +- docs/operations/queryanalyticsresponse.mdx | 2 +- docs/operations/ratelimit.mdx | 8 +- docs/operations/result.mdx | 6 +- .../sendchatcompletionrequestglobals.mdx | 6 +- .../sendchatcompletionrequestrequest.mdx | 10 +- .../signinterndaemonaccessrequestglobals.mdx | 6 +- .../signinterndaemonaccessrequestrequest.mdx | 10 +- .../signinterndaemonaccessrequestresponse.mdx | 4 +- .../signinterndaemonrequestglobals.mdx | 6 +- .../signinterndaemonrequestrequest.mdx | 10 +- .../signinterndaemonrequestresponse.mdx | 4 +- .../storeinternvaultsecretglobals.mdx | 6 +- .../storeinternvaultsecretrequest.mdx | 12 +- docs/operations/storevaultsecretglobals.mdx | 6 +- docs/operations/storevaultsecretrequest.mdx | 10 +- .../submitgenerationfeedbackglobals.mdx | 6 +- .../submitgenerationfeedbackrequest.mdx | 8 +- docs/operations/suspendinternglobals.mdx | 6 +- docs/operations/suspendinternrequest.mdx | 8 +- docs/operations/timerange.mdx | 4 +- docs/operations/updatebyokkeyglobals.mdx | 6 +- docs/operations/updatebyokkeyrequest.mdx | 10 +- docs/operations/updateenduserglobals.mdx | 6 +- docs/operations/updateenduserrequest.mdx | 10 +- docs/operations/updateguardrailglobals.mdx | 6 +- docs/operations/updateguardrailrequest.mdx | 10 +- docs/operations/updateinternglobals.mdx | 6 +- docs/operations/updateinternrequest.mdx | 10 +- docs/operations/updatekeysdata.mdx | 46 +-- docs/operations/updatekeysglobals.mdx | 6 +- docs/operations/updatekeysrequest.mdx | 10 +- docs/operations/updatekeysrequestbody.mdx | 12 +- docs/operations/updatekeysresponse.mdx | 2 +- .../updateobservabilitydestinationglobals.mdx | 6 +- .../updateobservabilitydestinationrequest.mdx | 10 +- .../updateorganizationsettingsglobals.mdx | 6 +- .../updateorganizationsettingsrequest.mdx | 8 +- .../updateorganizationsettingsresponse.mdx | 2 +- .../updateprivateendpointglobals.mdx | 6 +- .../updateprivateendpointpricingglobals.mdx | 6 +- .../updateprivateendpointpricingrequest.mdx | 10 +- .../updateprivateendpointrequest.mdx | 10 +- .../updatescimgroupmappingglobals.mdx | 6 +- .../updatescimgroupmappingrequest.mdx | 10 +- docs/operations/updateworkspaceglobals.mdx | 6 +- docs/operations/updateworkspacerequest.mdx | 10 +- docs/operations/uploadfilefile.mdx | 6 +- docs/operations/uploadfileglobals.mdx | 6 +- docs/operations/uploadfilerequest.mdx | 12 +- docs/operations/uploadfilerequestbody.mdx | 2 +- .../upsertworkspacebudgetglobals.mdx | 6 +- .../upsertworkspacebudgetrequest.mdx | 12 +- .../validateprivateendpointglobals.mdx | 6 +- .../validateprivateendpointrequest.mdx | 10 +- docs/sdks/analytics/README.mdx | 40 +-- docs/sdks/apikeys/README.mdx | 90 +++--- docs/sdks/batch/README.mdx | 56 ++-- docs/sdks/benchmarks/README.mdx | 26 +- docs/sdks/betaresponses/README.mdx | 88 +++--- docs/sdks/byok/README.mdx | 102 +++--- docs/sdks/chat/README.mdx | 94 +++--- docs/sdks/classifications/README.mdx | 10 +- docs/sdks/containers/README.mdx | 50 +-- docs/sdks/credits/README.mdx | 8 +- docs/sdks/datasets/README.mdx | 62 ++-- docs/sdks/decisions/README.mdx | 24 +- docs/sdks/embeddings/README.mdx | 38 +-- docs/sdks/endpoints/README.mdx | 20 +- docs/sdks/endusers/README.mdx | 58 ++-- docs/sdks/files/README.mdx | 80 ++--- docs/sdks/generations/README.mdx | 34 +- docs/sdks/guardrails/README.mdx | 242 +++++++------- docs/sdks/images/README.mdx | 62 ++-- docs/sdks/interns/README.mdx | 182 +++++------ docs/sdks/models/README.mdx | 104 +++--- docs/sdks/oauth/README.mdx | 66 ++-- docs/sdks/observability/README.mdx | 104 +++--- docs/sdks/organization/README.mdx | 30 +- docs/sdks/presets/README.mdx | 296 +++++++++--------- docs/sdks/privateendpoints/README.mdx | 128 ++++---- docs/sdks/providers/README.mdx | 8 +- docs/sdks/rerank/README.mdx | 24 +- docs/sdks/responses/README.mdx | 88 +++--- docs/sdks/scim/README.mdx | 94 +++--- docs/sdks/stt/README.mdx | 66 ++-- docs/sdks/systemone/README.mdx | 22 +- docs/sdks/tools/README.mdx | 28 +- docs/sdks/tts/README.mdx | 30 +- docs/sdks/vault/README.mdx | 104 +++--- docs/sdks/videogeneration/README.mdx | 74 ++--- docs/sdks/workspaces/README.mdx | 188 +++++------ 1452 files changed, 7893 insertions(+), 7893 deletions(-) diff --git a/docs/components/aabenchmarkentry.mdx b/docs/components/aabenchmarkentry.mdx index 172d96463..b99de065c 100644 --- a/docs/components/aabenchmarkentry.mdx +++ b/docs/components/aabenchmarkentry.mdx @@ -9,6 +9,6 @@ Artificial Analysis benchmark index scores. | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `agentic_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Agentic Index score | 55.8 | -| `coding_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Coding Index score | 63.2 | -| `intelligence_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file +| `agentic_index` | *Nullable[float]* | ✅ | Artificial Analysis Agentic Index score | 55.8 | +| `coding_index` | *Nullable[float]* | ✅ | Artificial Analysis Coding Index score | 63.2 | +| `intelligence_index` | *Nullable[float]* | ✅ | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file diff --git a/docs/components/activityitem.mdx b/docs/components/activityitem.mdx index c18a6d10b..753fb04e4 100644 --- a/docs/components/activityitem.mdx +++ b/docs/components/activityitem.mdx @@ -6,16 +6,16 @@ title: "ActivityItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage_inference` | *float* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | -| `cached_tokens` | *int* | :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 | -| `completion_tokens` | *int* | :heavy_check_mark: | Total completion tokens generated | 125 | -| `date_` | *str* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `endpoint_id` | *str* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `model` | *str* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `model_permaslug` | *str* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `prompt_tokens` | *int* | :heavy_check_mark: | Total prompt tokens used | 50 | -| `provider_name` | *str* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | -| `reasoning_tokens` | *int* | :heavy_check_mark: | Total reasoning tokens used | 25 | -| `requests` | *int* | :heavy_check_mark: | Number of requests made | 5 | -| `usage` | *float* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | -| `workspace_id` | *Optional[str]* | :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 +| `byok_usage_inference` | *float* | ✅ | BYOK inference cost in USD (external credits spent) | 0.012 | +| `cached_tokens` | *int* | ✅ | 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 | +| `completion_tokens` | *int* | ✅ | Total completion tokens generated | 125 | +| `date_` | *str* | ✅ | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | +| `endpoint_id` | *str* | ✅ | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | +| `model` | *str* | ✅ | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | +| `model_permaslug` | *str* | ✅ | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | +| `prompt_tokens` | *int* | ✅ | Total prompt tokens used | 50 | +| `provider_name` | *str* | ✅ | Name of the provider serving this endpoint | OpenAI | +| `reasoning_tokens` | *int* | ✅ | Total reasoning tokens used | 25 | +| `requests` | *int* | ✅ | Number of requests made | 5 | +| `usage` | *float* | ✅ | Total cost in USD (OpenRouter credits spent) | 0.015 | +| `workspace_id` | *Optional[str]* | ➖ | 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/components/activityresponse.mdx b/docs/components/activityresponse.mdx index 6edb98e87..6f16edc18 100644 --- a/docs/components/activityresponse.mdx +++ b/docs/components/activityresponse.mdx @@ -6,4 +6,4 @@ title: "ActivityResponse" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `data` | List[[components.ActivityItem](../components/activityitem.mdx)] | :heavy_check_mark: | List of activity items | \ No newline at end of file +| `data` | List[[components.ActivityItem](../components/activityitem.mdx)] | ✅ | List of activity items | \ No newline at end of file diff --git a/docs/components/additionaltoolsitem.mdx b/docs/components/additionaltoolsitem.mdx index 34d2291ed..3939b384a 100644 --- a/docs/components/additionaltoolsitem.mdx +++ b/docs/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[str]* | :heavy_minus_sign: | N/A | -| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A | -| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion.mdx)] | :heavy_check_mark: | N/A | -| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `id` | *OptionalNullable[str]* | ➖ | N/A | +| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole.mdx) | ✅ | N/A | +| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion.mdx)] | ✅ | N/A | +| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/additionaltoolsitemtool.mdx b/docs/components/additionaltoolsitemtool.mdx index 129b2fdfb..5659c3ab6 100644 --- a/docs/components/additionaltoolsitemtool.mdx +++ b/docs/components/additionaltoolsitemtool.mdx @@ -6,5 +6,5 @@ title: "AdditionalToolsItemTool" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *str* | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/additionaltoolsitemtoolfunction.mdx b/docs/components/additionaltoolsitemtoolfunction.mdx index 842c06ca1..fdf393ba9 100644 --- a/docs/components/additionaltoolsitemtoolfunction.mdx +++ b/docs/components/additionaltoolsitemtoolfunction.mdx @@ -9,12 +9,12 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `parameters` | Dict[str, *Any*] | :heavy_check_mark: | N/A | | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `type` | [components.AdditionalToolsItemTypeFunction](../components/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A | | -| `allowed_callers` | List[[components.AdditionalToolsItemAllowedCaller](../components/additionaltoolsitemallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | -| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `description` | *OptionalNullable[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `parameters` | Dict[str, *Any*] | ✅ | N/A | | +| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | +| `type` | [components.AdditionalToolsItemTypeFunction](../components/additionaltoolsitemtypefunction.mdx) | ✅ | N/A | | +| `allowed_callers` | List[[components.AdditionalToolsItemAllowedCaller](../components/additionaltoolsitemallowedcaller.mdx)] | ➖ | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | +| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/advisorreasoning.mdx b/docs/components/advisorreasoning.mdx index b33ef5366..fe99b3c61 100644 --- a/docs/components/advisorreasoning.mdx +++ b/docs/components/advisorreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the advisor call. Use this to control reaso | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `effort` | [Optional[components.AdvisorReasoningEffort]](../components/advisorreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the advisor call. | -| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file +| `effort` | [Optional[components.AdvisorReasoningEffort]](../components/advisorreasoningeffort.mdx) | ➖ | Reasoning effort level for the advisor call. | +| `max_tokens` | *Optional[int]* | ➖ | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file diff --git a/docs/components/advisorservertoolconfig.mdx b/docs/components/advisorservertoolconfig.mdx index 5aa0ee10c..7e506a3af 100644 --- a/docs/components/advisorservertoolconfig.mdx +++ b/docs/components/advisorservertoolconfig.mdx @@ -9,11 +9,11 @@ Configuration for one openrouter:advisor server tool entry. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `forward_transcript` | *Optional[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` | *Optional[str]* | :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. | -| `max_completion_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | -| `model` | *Optional[str]* | :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` | *Optional[str]* | :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` | [Optional[components.AdvisorReasoning]](../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` | *Optional[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` | *Optional[float]* | :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 +| `forward_transcript` | *Optional[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` | *Optional[str]* | ➖ | 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. | +| `max_completion_tokens` | *Optional[int]* | ➖ | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | +| `model` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.AdvisorReasoning]](../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` | *Optional[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` | *Optional[float]* | ➖ | 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/components/advisorservertoolopenrouter.mdx b/docs/components/advisorservertoolopenrouter.mdx index 3c141ae51..5854fc0a5 100644 --- a/docs/components/advisorservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.AdvisorServerToolConfig]](../components/advisorservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | -| `type` | [components.AdvisorServerToolOpenRouterType](../components/advisorservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.AdvisorServerToolConfig]](../components/advisorservertoolconfig.mdx) | ➖ | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | +| `type` | [components.AdvisorServerToolOpenRouterType](../components/advisorservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/agent.mdx b/docs/components/agent.mdx index 198da9e83..11f9405f8 100644 --- a/docs/components/agent.mdx +++ b/docs/components/agent.mdx @@ -6,5 +6,5 @@ title: "Agent" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `agent_name` | *str* | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `agent_name` | *str* | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/agentmessageitem.mdx b/docs/components/agentmessageitem.mdx index 6c75e26dd..229ca2345 100644 --- a/docs/components/agentmessageitem.mdx +++ b/docs/components/agentmessageitem.mdx @@ -9,10 +9,10 @@ A message routed between agents in a multi-agent session | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `agent` | [OptionalNullable[components.Agent]](../components/agent.mdx) | :heavy_minus_sign: | N/A | | -| `author` | *str* | :heavy_check_mark: | N/A | | -| `content` | List[[components.AgentMessageItemContentUnion](../components/agentmessageitemcontentunion.mdx)] | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `recipient` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.TypeAgentMessage](../components/typeagentmessage.mdx) | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *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[components.Agent]](../components/agent.mdx) | ➖ | N/A | | +| `author` | *str* | ✅ | N/A | | +| `content` | List[[components.AgentMessageItemContentUnion](../components/agentmessageitemcontentunion.mdx)] | ✅ | N/A | | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `recipient` | *str* | ✅ | N/A | | +| `type` | [components.TypeAgentMessage](../components/typeagentmessage.mdx) | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/agentmessageitemcontentinputimage.mdx b/docs/components/agentmessageitemcontentinputimage.mdx index 94ab47b17..412ca03f4 100644 --- a/docs/components/agentmessageitemcontentinputimage.mdx +++ b/docs/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](../components/agentmessageitemdetail.mdx) | :heavy_check_mark: | N/A | -| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.AgentMessageItemTypeInputImage](../components/agentmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [components.AgentMessageItemDetail](../components/agentmessageitemdetail.mdx) | ✅ | N/A | +| `file_id` | *OptionalNullable[str]* | ➖ | N/A | +| `image_url` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.AgentMessageItemTypeInputImage](../components/agentmessageitemtypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/alignment.mdx b/docs/components/alignment.mdx index 112c870ba..4766f1b53 100644 --- a/docs/components/alignment.mdx +++ b/docs/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` | List[[components.AlignmentCallRecord](../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` | List[[components.AlignmentCallRecord](../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/components/alignmentallowedcallrecord.mdx b/docs/components/alignmentallowedcallrecord.mdx index 312b5ea4a..289916bfa 100644 --- a/docs/components/alignmentallowedcallrecord.mdx +++ b/docs/components/alignmentallowedcallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentAllowedCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call` | *int* | :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](../components/alignmentallowedcallrecordoutcome.mdx) | :heavy_check_mark: | N/A | -| `rules` | List[[components.AlignmentRuleRecord](../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` | *int* | ✅ | 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](../components/alignmentallowedcallrecordoutcome.mdx) | ✅ | N/A | +| `rules` | List[[components.AlignmentRuleRecord](../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/components/alignmentblockedcallrecord.mdx b/docs/components/alignmentblockedcallrecord.mdx index 95e38c650..60bcf2b73 100644 --- a/docs/components/alignmentblockedcallrecord.mdx +++ b/docs/components/alignmentblockedcallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentBlockedCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call` | *int* | :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](../components/alignmentblockedcallrecordoutcome.mdx) | :heavy_check_mark: | N/A | -| `rules` | List[[components.AlignmentRuleRecord](../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` | *int* | ✅ | 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](../components/alignmentblockedcallrecordoutcome.mdx) | ✅ | N/A | +| `rules` | List[[components.AlignmentRuleRecord](../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/components/alignmentchataudio.mdx b/docs/components/alignmentchataudio.mdx index 891393b74..20f46d2fb 100644 --- a/docs/components/alignmentchataudio.mdx +++ b/docs/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` | *Optional[str]* | :heavy_minus_sign: | The provider id of the audio. | -| `transcript` | *str* | :heavy_check_mark: | The transcript of the audio. | \ No newline at end of file +| `id` | *Optional[str]* | ➖ | The provider id of the audio. | +| `transcript` | *str* | ✅ | The transcript of the audio. | \ No newline at end of file diff --git a/docs/components/alignmentchatimage.mdx b/docs/components/alignmentchatimage.mdx index f44d4af7a..fa9039dcf 100644 --- a/docs/components/alignmentchatimage.mdx +++ b/docs/components/alignmentchatimage.mdx @@ -6,5 +6,5 @@ title: "AlignmentChatImage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `image_url` | [components.AlignmentChatImageImageURL](../components/alignmentchatimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.AlignmentChatImageType](../components/alignmentchatimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `image_url` | [components.AlignmentChatImageImageURL](../components/alignmentchatimageimageurl.mdx) | ✅ | N/A | +| `type` | [components.AlignmentChatImageType](../components/alignmentchatimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/alignmentchatimageimageurl.mdx b/docs/components/alignmentchatimageimageurl.mdx index c5f4fff07..4c98024c4 100644 --- a/docs/components/alignmentchatimageimageurl.mdx +++ b/docs/components/alignmentchatimageimageurl.mdx @@ -6,4 +6,4 @@ title: "AlignmentChatImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/alignmentchatrejected.mdx b/docs/components/alignmentchatrejected.mdx index 6210da6a6..bb6fdc1b9 100644 --- a/docs/components/alignmentchatrejected.mdx +++ b/docs/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` | [Optional[components.AlignmentChatAudio]](../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` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `images` | List[[components.AlignmentChatImage](../components/alignmentchatimage.mdx)] | :heavy_minus_sign: | N/A | | -| `refusal` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `role` | [components.AlignmentChatRejectedRole](../components/alignmentchatrejectedrole.mdx) | :heavy_check_mark: | N/A | | -| `tool_calls` | List[[components.AlignmentChatToolCall](../components/alignmentchattoolcall.mdx)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `audio` | [Optional[components.AlignmentChatAudio]](../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` | *Nullable[str]* | ✅ | N/A | | +| `images` | List[[components.AlignmentChatImage](../components/alignmentchatimage.mdx)] | ➖ | N/A | | +| `refusal` | *Nullable[str]* | ✅ | N/A | | +| `role` | [components.AlignmentChatRejectedRole](../components/alignmentchatrejectedrole.mdx) | ✅ | N/A | | +| `tool_calls` | List[[components.AlignmentChatToolCall](../components/alignmentchattoolcall.mdx)] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/alignmentchattoolcall.mdx b/docs/components/alignmentchattoolcall.mdx index 265c22b70..1889a1362 100644 --- a/docs/components/alignmentchattoolcall.mdx +++ b/docs/components/alignmentchattoolcall.mdx @@ -6,6 +6,6 @@ title: "AlignmentChatToolCall" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `function` | [components.AlignmentChatToolCallFunction](../components/alignmentchattoolcallfunction.mdx) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AlignmentChatToolCallType](../components/alignmentchattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `function` | [components.AlignmentChatToolCallFunction](../components/alignmentchattoolcallfunction.mdx) | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `type` | [components.AlignmentChatToolCallType](../components/alignmentchattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/alignmentchattoolcallfunction.mdx b/docs/components/alignmentchattoolcallfunction.mdx index ef02a544e..40ad8af96 100644 --- a/docs/components/alignmentchattoolcallfunction.mdx +++ b/docs/components/alignmentchattoolcallfunction.mdx @@ -6,5 +6,5 @@ title: "AlignmentChatToolCallFunction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | +| `name` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/alignmentplugin.mdx b/docs/components/alignmentplugin.mdx index 0c01e3d04..52acaa0ea 100644 --- a/docs/components/alignmentplugin.mdx +++ b/docs/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](../components/alignmentpluginid.mdx) | :heavy_check_mark: | N/A | | -| `instruct` | *Optional[bool]* | :heavy_minus_sign: | Whether the rules are stated to the model in a system message on every provider call. Default true. | | -| `max_retries` | *Optional[int]* | :heavy_minus_sign: | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | -| `mode` | [Optional[components.AlignmentPluginMode]](../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` | List[*str*] | :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` | *Optional[float]* | :heavy_minus_sign: | Probability at or above which a rule is broken. Default 0.7. | | \ No newline at end of file +| `id` | [components.AlignmentPluginID](../components/alignmentpluginid.mdx) | ✅ | N/A | | +| `instruct` | *Optional[bool]* | ➖ | Whether the rules are stated to the model in a system message on every provider call. Default true. | | +| `max_retries` | *Optional[int]* | ➖ | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | +| `mode` | [Optional[components.AlignmentPluginMode]](../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` | List[*str*] | ✅ | 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` | *Optional[float]* | ➖ | Probability at or above which a rule is broken. Default 0.7. | | \ No newline at end of file diff --git a/docs/components/alignmentrulerecord.mdx b/docs/components/alignmentrulerecord.mdx index 74a00b060..76971e467 100644 --- a/docs/components/alignmentrulerecord.mdx +++ b/docs/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` | *float* | :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` | *float* | ✅ | The evaluator's probability that the turn breaks the rule. | \ No newline at end of file diff --git a/docs/components/alignmentunavailablecallrecord.mdx b/docs/components/alignmentunavailablecallrecord.mdx index cd46fe478..ed3097b0c 100644 --- a/docs/components/alignmentunavailablecallrecord.mdx +++ b/docs/components/alignmentunavailablecallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentUnavailableCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call` | *int* | :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](../components/alignmentunavailablecallrecordoutcome.mdx) | :heavy_check_mark: | N/A | -| `reason` | [components.AlignmentUnavailableCallRecordReason](../components/alignmentunavailablecallrecordreason.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `call` | *int* | ✅ | 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](../components/alignmentunavailablecallrecordoutcome.mdx) | ✅ | N/A | +| `reason` | [components.AlignmentUnavailableCallRecordReason](../components/alignmentunavailablecallrecordreason.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/allowedtools.mdx b/docs/components/allowedtools.mdx index 14377fe6a..fa714f9e6 100644 --- a/docs/components/allowedtools.mdx +++ b/docs/components/allowedtools.mdx @@ -6,5 +6,5 @@ title: "AllowedTools" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `read_only` | *Optional[bool]* | ➖ | N/A | +| `tool_names` | List[*str*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/always.mdx b/docs/components/always.mdx index 539af0bb9..7be3d5420 100644 --- a/docs/components/always.mdx +++ b/docs/components/always.mdx @@ -6,4 +6,4 @@ title: "Always" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `tool_names` | List[*str*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/annotationaddedevent.mdx b/docs/components/annotationaddedevent.mdx index d05a06237..f21237810 100644 --- a/docs/components/annotationaddedevent.mdx +++ b/docs/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](../components/openairesponsesannotation.mdx) | :heavy_check_mark: | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | -| `annotation_index` | *int* | :heavy_check_mark: | N/A | | -| `content_index` | *int* | :heavy_check_mark: | N/A | | -| `item_id` | *str* | :heavy_check_mark: | N/A | | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.AnnotationAddedEventType](../components/annotationaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `annotation` | [components.OpenAIResponsesAnnotation](../components/openairesponsesannotation.mdx) | ✅ | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | +| `annotation_index` | *int* | ✅ | N/A | | +| `content_index` | *int* | ✅ | N/A | | +| `item_id` | *str* | ✅ | N/A | | +| `output_index` | *int* | ✅ | N/A | | +| `sequence_number` | *int* | ✅ | N/A | | +| `type` | [components.AnnotationAddedEventType](../components/annotationaddedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/annotationfile.mdx b/docs/components/annotationfile.mdx index 50ae7e895..f1120ec04 100644 --- a/docs/components/annotationfile.mdx +++ b/docs/components/annotationfile.mdx @@ -6,5 +6,5 @@ title: "AnnotationFile" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `file` | [components.BatchObjectFile](../components/batchobjectfile.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.AnnotationTypeFile](../components/annotationtypefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file` | [components.BatchObjectFile](../components/batchobjectfile.mdx) | ✅ | N/A | +| `type` | [components.AnnotationTypeFile](../components/annotationtypefile.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/annotationurlcitation.mdx b/docs/components/annotationurlcitation.mdx index 871c61915..6eab2f076 100644 --- a/docs/components/annotationurlcitation.mdx +++ b/docs/components/annotationurlcitation.mdx @@ -6,5 +6,5 @@ title: "AnnotationURLCitation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnnotationTypeURLCitation](../components/annotationtypeurlcitation.mdx) | :heavy_check_mark: | N/A | -| `url_citation` | [components.BatchObjectURLCitation](../components/batchobjecturlcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.AnnotationTypeURLCitation](../components/annotationtypeurlcitation.mdx) | ✅ | N/A | +| `url_citation` | [components.BatchObjectURLCitation](../components/batchobjecturlcitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/annotationwebsearchcitation.mdx b/docs/components/annotationwebsearchcitation.mdx index a349dfd1f..1c94b0974 100644 --- a/docs/components/annotationwebsearchcitation.mdx +++ b/docs/components/annotationwebsearchcitation.mdx @@ -6,5 +6,5 @@ title: "AnnotationWebSearchCitation" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [components.TypeWebSearchCitation](../components/typewebsearchcitation.mdx) | :heavy_check_mark: | N/A | -| `web_search_citation` | [components.WebSearchCitation](../components/websearchcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.TypeWebSearchCitation](../components/typewebsearchcitation.mdx) | ✅ | N/A | +| `web_search_citation` | [components.WebSearchCitation](../components/websearchcitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicadvisormessageusageiteration.mdx b/docs/components/anthropicadvisormessageusageiteration.mdx index 0d71d3657..85fca0d67 100644 --- a/docs/components/anthropicadvisormessageusageiteration.mdx +++ b/docs/components/anthropicadvisormessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicAdvisorMessageUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicAdvisorMessageUsageIterationType](../components/anthropicadvisormessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cache_creation_input_tokens` | *Optional[int]* | ➖ | N/A | | +| `cache_read_input_tokens` | *Optional[int]* | ➖ | N/A | | +| `input_tokens` | *Optional[int]* | ➖ | N/A | | +| `output_tokens` | *Optional[int]* | ➖ | N/A | | +| `model` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicAdvisorMessageUsageIterationType](../components/anthropicadvisormessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicadvisortoolresult.mdx b/docs/components/anthropicadvisortoolresult.mdx index 6511ee485..be52da7ba 100644 --- a/docs/components/anthropicadvisortoolresult.mdx +++ b/docs/components/anthropicadvisortoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicAdvisorToolResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `content` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicAdvisorToolResultType](../components/anthropicadvisortoolresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | Dict[str, *Any*] | ✅ | N/A | +| `tool_use_id` | *str* | ✅ | N/A | +| `type` | [components.AnthropicAdvisorToolResultType](../components/anthropicadvisortoolresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicbase64imagesource.mdx b/docs/components/anthropicbase64imagesource.mdx index 31e75cf2b..6b399f00d 100644 --- a/docs/components/anthropicbase64imagesource.mdx +++ b/docs/components/anthropicbase64imagesource.mdx @@ -6,6 +6,6 @@ title: "AnthropicBase64ImageSource" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | | -| `media_type` | [components.AnthropicImageMimeType](../components/anthropicimagemimetype.mdx) | :heavy_check_mark: | N/A | image/jpeg | -| `type` | [components.AnthropicBase64ImageSourceType](../components/anthropicbase64imagesourcetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `data` | *str* | ✅ | N/A | | +| `media_type` | [components.AnthropicImageMimeType](../components/anthropicimagemimetype.mdx) | ✅ | N/A | image/jpeg | +| `type` | [components.AnthropicBase64ImageSourceType](../components/anthropicbase64imagesourcetype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicbase64pdfsource.mdx b/docs/components/anthropicbase64pdfsource.mdx index 40f042630..ab9012075 100644 --- a/docs/components/anthropicbase64pdfsource.mdx +++ b/docs/components/anthropicbase64pdfsource.mdx @@ -6,6 +6,6 @@ title: "AnthropicBase64PdfSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | -| `media_type` | [components.AnthropicBase64PdfSourceMediaType](../components/anthropicbase64pdfsourcemediatype.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicBase64PdfSourceType](../components/anthropicbase64pdfsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *str* | ✅ | N/A | +| `media_type` | [components.AnthropicBase64PdfSourceMediaType](../components/anthropicbase64pdfsourcemediatype.mdx) | ✅ | N/A | +| `type` | [components.AnthropicBase64PdfSourceType](../components/anthropicbase64pdfsourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicbashcodeexecutionoutput.mdx b/docs/components/anthropicbashcodeexecutionoutput.mdx index dc3f6e0ff..8780145b8 100644 --- a/docs/components/anthropicbashcodeexecutionoutput.mdx +++ b/docs/components/anthropicbashcodeexecutionoutput.mdx @@ -6,5 +6,5 @@ title: "AnthropicBashCodeExecutionOutput" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicBashCodeExecutionOutputType](../components/anthropicbashcodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file_id` | *str* | ✅ | N/A | +| `type` | [components.AnthropicBashCodeExecutionOutputType](../components/anthropicbashcodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicbashcodeexecutionresult.mdx b/docs/components/anthropicbashcodeexecutionresult.mdx index a48a5058a..c3678aa02 100644 --- a/docs/components/anthropicbashcodeexecutionresult.mdx +++ b/docs/components/anthropicbashcodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicBashCodeExecutionResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.AnthropicBashCodeExecutionOutput](../components/anthropicbashcodeexecutionoutput.mdx)] | :heavy_check_mark: | N/A | -| `return_code` | *int* | :heavy_check_mark: | N/A | -| `stderr` | *str* | :heavy_check_mark: | N/A | -| `stdout` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicBashCodeExecutionResultType](../components/anthropicbashcodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | List[[components.AnthropicBashCodeExecutionOutput](../components/anthropicbashcodeexecutionoutput.mdx)] | ✅ | N/A | +| `return_code` | *int* | ✅ | N/A | +| `stderr` | *str* | ✅ | N/A | +| `stdout` | *str* | ✅ | N/A | +| `type` | [components.AnthropicBashCodeExecutionResultType](../components/anthropicbashcodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicbashcodeexecutiontoolresult.mdx b/docs/components/anthropicbashcodeexecutiontoolresult.mdx index 339bf784d..04b28ba39 100644 --- a/docs/components/anthropicbashcodeexecutiontoolresult.mdx +++ b/docs/components/anthropicbashcodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicBashCodeExecutionToolResult" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicBashCodeExecutionContent](../components/anthropicbashcodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicBashCodeExecutionToolResultType](../components/anthropicbashcodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [components.AnthropicBashCodeExecutionContent](../components/anthropicbashcodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | +| `tool_use_id` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicBashCodeExecutionToolResultType](../components/anthropicbashcodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicbashcodeexecutiontoolresulterror.mdx b/docs/components/anthropicbashcodeexecutiontoolresulterror.mdx index ad9c88d12..775e485c3 100644 --- a/docs/components/anthropicbashcodeexecutiontoolresulterror.mdx +++ b/docs/components/anthropicbashcodeexecutiontoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicBashCodeExecutionToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `error_code` | [components.AnthropicBashCodeExecutionToolResultErrorErrorCode](../components/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicBashCodeExecutionToolResultErrorType](../components/anthropicbashcodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error_code` | [components.AnthropicBashCodeExecutionToolResultErrorErrorCode](../components/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `type` | [components.AnthropicBashCodeExecutionToolResultErrorType](../components/anthropicbashcodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccachecontroldirective.mdx b/docs/components/anthropiccachecontroldirective.mdx index 12b753fe8..a6c16403b 100644 --- a/docs/components/anthropiccachecontroldirective.mdx +++ b/docs/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` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `type` | [components.AnthropicCacheControlDirectiveType](../components/anthropiccachecontroldirectivetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | +| `type` | [components.AnthropicCacheControlDirectiveType](../components/anthropiccachecontroldirectivetype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropiccachecreation.mdx b/docs/components/anthropiccachecreation.mdx index c9562a64e..9f62d0c65 100644 --- a/docs/components/anthropiccachecreation.mdx +++ b/docs/components/anthropiccachecreation.mdx @@ -6,5 +6,5 @@ title: "AnthropicCacheCreation" | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `ephemeral_1h_input_tokens` | *int* | :heavy_check_mark: | N/A | -| `ephemeral_5m_input_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `ephemeral_1h_input_tokens` | *int* | ✅ | N/A | +| `ephemeral_5m_input_tokens` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationcharlocation.mdx b/docs/components/anthropiccitationcharlocation.mdx index 9a79e2d26..38b939e7c 100644 --- a/docs/components/anthropiccitationcharlocation.mdx +++ b/docs/components/anthropiccitationcharlocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationCharLocation" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `document_index` | *int* | :heavy_check_mark: | N/A | -| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `end_char_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `start_char_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationCharLocationType](../components/anthropiccitationcharlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `document_index` | *int* | ✅ | N/A | +| `document_title` | *Nullable[str]* | ✅ | N/A | +| `end_char_index` | *int* | ✅ | N/A | +| `file_id` | *Nullable[str]* | ✅ | N/A | +| `start_char_index` | *int* | ✅ | N/A | +| `type` | [components.AnthropicCitationCharLocationType](../components/anthropiccitationcharlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationcharlocationparam.mdx b/docs/components/anthropiccitationcharlocationparam.mdx index 5a68da554..fca466aae 100644 --- a/docs/components/anthropiccitationcharlocationparam.mdx +++ b/docs/components/anthropiccitationcharlocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationCharLocationParam" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `document_index` | *int* | :heavy_check_mark: | N/A | -| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `end_char_index` | *int* | :heavy_check_mark: | N/A | -| `start_char_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationCharLocationParamType](../components/anthropiccitationcharlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `document_index` | *int* | ✅ | N/A | +| `document_title` | *Nullable[str]* | ✅ | N/A | +| `end_char_index` | *int* | ✅ | N/A | +| `start_char_index` | *int* | ✅ | N/A | +| `type` | [components.AnthropicCitationCharLocationParamType](../components/anthropiccitationcharlocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationcontentblocklocation.mdx b/docs/components/anthropiccitationcontentblocklocation.mdx index ae50edb4e..03920da8a 100644 --- a/docs/components/anthropiccitationcontentblocklocation.mdx +++ b/docs/components/anthropiccitationcontentblocklocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationContentBlockLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `document_index` | *int* | :heavy_check_mark: | N/A | -| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `end_block_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `start_block_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationContentBlockLocationType](../components/anthropiccitationcontentblocklocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `document_index` | *int* | ✅ | N/A | +| `document_title` | *Nullable[str]* | ✅ | N/A | +| `end_block_index` | *int* | ✅ | N/A | +| `file_id` | *Nullable[str]* | ✅ | N/A | +| `start_block_index` | *int* | ✅ | N/A | +| `type` | [components.AnthropicCitationContentBlockLocationType](../components/anthropiccitationcontentblocklocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationcontentblocklocationparam.mdx b/docs/components/anthropiccitationcontentblocklocationparam.mdx index b0353d9cc..6e88066df 100644 --- a/docs/components/anthropiccitationcontentblocklocationparam.mdx +++ b/docs/components/anthropiccitationcontentblocklocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationContentBlockLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `document_index` | *int* | :heavy_check_mark: | N/A | -| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `end_block_index` | *int* | :heavy_check_mark: | N/A | -| `start_block_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationContentBlockLocationParamType](../components/anthropiccitationcontentblocklocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `document_index` | *int* | ✅ | N/A | +| `document_title` | *Nullable[str]* | ✅ | N/A | +| `end_block_index` | *int* | ✅ | N/A | +| `start_block_index` | *int* | ✅ | N/A | +| `type` | [components.AnthropicCitationContentBlockLocationParamType](../components/anthropiccitationcontentblocklocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationpagelocation.mdx b/docs/components/anthropiccitationpagelocation.mdx index d9cb06aeb..922d48039 100644 --- a/docs/components/anthropiccitationpagelocation.mdx +++ b/docs/components/anthropiccitationpagelocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationPageLocation" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `document_index` | *int* | :heavy_check_mark: | N/A | -| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `end_page_number` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `start_page_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationPageLocationType](../components/anthropiccitationpagelocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `document_index` | *int* | ✅ | N/A | +| `document_title` | *Nullable[str]* | ✅ | N/A | +| `end_page_number` | *int* | ✅ | N/A | +| `file_id` | *Nullable[str]* | ✅ | N/A | +| `start_page_number` | *int* | ✅ | N/A | +| `type` | [components.AnthropicCitationPageLocationType](../components/anthropiccitationpagelocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationpagelocationparam.mdx b/docs/components/anthropiccitationpagelocationparam.mdx index 137db690f..6993270ee 100644 --- a/docs/components/anthropiccitationpagelocationparam.mdx +++ b/docs/components/anthropiccitationpagelocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationPageLocationParam" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `document_index` | *int* | :heavy_check_mark: | N/A | -| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `end_page_number` | *int* | :heavy_check_mark: | N/A | -| `start_page_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationPageLocationParamType](../components/anthropiccitationpagelocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `document_index` | *int* | ✅ | N/A | +| `document_title` | *Nullable[str]* | ✅ | N/A | +| `end_page_number` | *int* | ✅ | N/A | +| `start_page_number` | *int* | ✅ | N/A | +| `type` | [components.AnthropicCitationPageLocationParamType](../components/anthropiccitationpagelocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationsconfig.mdx b/docs/components/anthropiccitationsconfig.mdx index de669423c..82e6fe2e4 100644 --- a/docs/components/anthropiccitationsconfig.mdx +++ b/docs/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/components/anthropiccitationsearchresultlocation.mdx b/docs/components/anthropiccitationsearchresultlocation.mdx index 4766fcaad..e2e945d17 100644 --- a/docs/components/anthropiccitationsearchresultlocation.mdx +++ b/docs/components/anthropiccitationsearchresultlocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationSearchResultLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `end_block_index` | *int* | :heavy_check_mark: | N/A | -| `search_result_index` | *int* | :heavy_check_mark: | N/A | -| `source` | *str* | :heavy_check_mark: | N/A | -| `start_block_index` | *int* | :heavy_check_mark: | N/A | -| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationSearchResultLocationType](../components/anthropiccitationsearchresultlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `end_block_index` | *int* | ✅ | N/A | +| `search_result_index` | *int* | ✅ | N/A | +| `source` | *str* | ✅ | N/A | +| `start_block_index` | *int* | ✅ | N/A | +| `title` | *Nullable[str]* | ✅ | N/A | +| `type` | [components.AnthropicCitationSearchResultLocationType](../components/anthropiccitationsearchresultlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationsearchresultlocationparam.mdx b/docs/components/anthropiccitationsearchresultlocationparam.mdx index 8d0c9d2ac..f3d6bdc71 100644 --- a/docs/components/anthropiccitationsearchresultlocationparam.mdx +++ b/docs/components/anthropiccitationsearchresultlocationparam.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationSearchResultLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `end_block_index` | *int* | :heavy_check_mark: | N/A | -| `search_result_index` | *int* | :heavy_check_mark: | N/A | -| `source` | *str* | :heavy_check_mark: | N/A | -| `start_block_index` | *int* | :heavy_check_mark: | N/A | -| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationSearchResultLocationParamType](../components/anthropiccitationsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `end_block_index` | *int* | ✅ | N/A | +| `search_result_index` | *int* | ✅ | N/A | +| `source` | *str* | ✅ | N/A | +| `start_block_index` | *int* | ✅ | N/A | +| `title` | *Nullable[str]* | ✅ | N/A | +| `type` | [components.AnthropicCitationSearchResultLocationParamType](../components/anthropiccitationsearchresultlocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationwebsearchresultlocation.mdx b/docs/components/anthropiccitationwebsearchresultlocation.mdx index b03268fdf..08df7f3a6 100644 --- a/docs/components/anthropiccitationwebsearchresultlocation.mdx +++ b/docs/components/anthropiccitationwebsearchresultlocation.mdx @@ -6,8 +6,8 @@ title: "AnthropicCitationWebSearchResultLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `encrypted_index` | *str* | :heavy_check_mark: | N/A | -| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationWebSearchResultLocationType](../components/anthropiccitationwebsearchresultlocationtype.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `encrypted_index` | *str* | ✅ | N/A | +| `title` | *Nullable[str]* | ✅ | N/A | +| `type` | [components.AnthropicCitationWebSearchResultLocationType](../components/anthropiccitationwebsearchresultlocationtype.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccitationwebsearchresultlocationparam.mdx b/docs/components/anthropiccitationwebsearchresultlocationparam.mdx index 9b59d45b7..e5d6bf6ab 100644 --- a/docs/components/anthropiccitationwebsearchresultlocationparam.mdx +++ b/docs/components/anthropiccitationwebsearchresultlocationparam.mdx @@ -6,8 +6,8 @@ title: "AnthropicCitationWebSearchResultLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `encrypted_index` | *str* | :heavy_check_mark: | N/A | -| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationWebSearchResultLocationParamType](../components/anthropiccitationwebsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *str* | ✅ | N/A | +| `encrypted_index` | *str* | ✅ | N/A | +| `title` | *Nullable[str]* | ✅ | N/A | +| `type` | [components.AnthropicCitationWebSearchResultLocationParamType](../components/anthropiccitationwebsearchresultlocationparamtype.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecution20250825caller.mdx b/docs/components/anthropiccodeexecution20250825caller.mdx index 78b363bf4..ab9f1ca6d 100644 --- a/docs/components/anthropiccodeexecution20250825caller.mdx +++ b/docs/components/anthropiccodeexecution20250825caller.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecution20250825Caller" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `tool_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCodeExecution20250825CallerType](../components/anthropiccodeexecution20250825callertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `tool_id` | *str* | ✅ | N/A | +| `type` | [components.AnthropicCodeExecution20250825CallerType](../components/anthropiccodeexecution20250825callertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecution20260120caller.mdx b/docs/components/anthropiccodeexecution20260120caller.mdx index 6c863ec8c..01e5b0e16 100644 --- a/docs/components/anthropiccodeexecution20260120caller.mdx +++ b/docs/components/anthropiccodeexecution20260120caller.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecution20260120Caller" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `tool_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCodeExecution20260120CallerType](../components/anthropiccodeexecution20260120callertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `tool_id` | *str* | ✅ | N/A | +| `type` | [components.AnthropicCodeExecution20260120CallerType](../components/anthropiccodeexecution20260120callertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecutionoutput.mdx b/docs/components/anthropiccodeexecutionoutput.mdx index 12529bc3c..394d957ab 100644 --- a/docs/components/anthropiccodeexecutionoutput.mdx +++ b/docs/components/anthropiccodeexecutionoutput.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecutionOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCodeExecutionOutputType](../components/anthropiccodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file_id` | *str* | ✅ | N/A | +| `type` | [components.AnthropicCodeExecutionOutputType](../components/anthropiccodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecutionresult.mdx b/docs/components/anthropiccodeexecutionresult.mdx index c1e3a98c9..7b6757bd7 100644 --- a/docs/components/anthropiccodeexecutionresult.mdx +++ b/docs/components/anthropiccodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicCodeExecutionResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `content` | List[[components.AnthropicCodeExecutionOutput](../components/anthropiccodeexecutionoutput.mdx)] | :heavy_check_mark: | N/A | -| `return_code` | *int* | :heavy_check_mark: | N/A | -| `stderr` | *str* | :heavy_check_mark: | N/A | -| `stdout` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCodeExecutionResultType](../components/anthropiccodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | List[[components.AnthropicCodeExecutionOutput](../components/anthropiccodeexecutionoutput.mdx)] | ✅ | N/A | +| `return_code` | *int* | ✅ | N/A | +| `stderr` | *str* | ✅ | N/A | +| `stdout` | *str* | ✅ | N/A | +| `type` | [components.AnthropicCodeExecutionResultType](../components/anthropiccodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecutiontoolresult.mdx b/docs/components/anthropiccodeexecutiontoolresult.mdx index fa5095cd6..f74485d3e 100644 --- a/docs/components/anthropiccodeexecutiontoolresult.mdx +++ b/docs/components/anthropiccodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicCodeExecutionToolResult" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicCodeExecutionContent](../components/anthropiccodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicCodeExecutionToolResultType](../components/anthropiccodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [components.AnthropicCodeExecutionContent](../components/anthropiccodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | +| `tool_use_id` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicCodeExecutionToolResultType](../components/anthropiccodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropiccodeexecutiontoolresulterror.mdx b/docs/components/anthropiccodeexecutiontoolresulterror.mdx index 200c14d0a..421e97cbd 100644 --- a/docs/components/anthropiccodeexecutiontoolresulterror.mdx +++ b/docs/components/anthropiccodeexecutiontoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecutionToolResultError" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `error_code` | [components.AnthropicServerToolErrorCode](../components/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | -| `type` | [components.AnthropicCodeExecutionToolResultErrorType](../components/anthropiccodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `error_code` | [components.AnthropicServerToolErrorCode](../components/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | +| `type` | [components.AnthropicCodeExecutionToolResultErrorType](../components/anthropiccodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropiccompactionblock.mdx b/docs/components/anthropiccompactionblock.mdx index 95ab206ec..5457d7705 100644 --- a/docs/components/anthropiccompactionblock.mdx +++ b/docs/components/anthropiccompactionblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicCompactionBlock" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `content` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.AnthropicCompactionBlockType](../components/anthropiccompactionblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *Nullable[str]* | ✅ | N/A | +| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.AnthropicCompactionBlockType](../components/anthropiccompactionblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccompactionusageiteration.mdx b/docs/components/anthropiccompactionusageiteration.mdx index 2f0a28b5a..fd869bd12 100644 --- a/docs/components/anthropiccompactionusageiteration.mdx +++ b/docs/components/anthropiccompactionusageiteration.mdx @@ -6,9 +6,9 @@ title: "AnthropicCompactionUsageIteration" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `type` | [components.AnthropicCompactionUsageIterationType](../components/anthropiccompactionusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cache_creation_input_tokens` | *Optional[int]* | ➖ | N/A | | +| `cache_read_input_tokens` | *Optional[int]* | ➖ | N/A | | +| `input_tokens` | *Optional[int]* | ➖ | N/A | | +| `output_tokens` | *Optional[int]* | ➖ | N/A | | +| `type` | [components.AnthropicCompactionUsageIterationType](../components/anthropiccompactionusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropiccontainer.mdx b/docs/components/anthropiccontainer.mdx index 620f42751..cc4602aaf 100644 --- a/docs/components/anthropiccontainer.mdx +++ b/docs/components/anthropiccontainer.mdx @@ -6,6 +6,6 @@ title: "AnthropicContainer" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `expires_at` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `skills` | List[[components.AnthropicContainerSkill](../components/anthropiccontainerskill.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `expires_at` | *str* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `skills` | List[[components.AnthropicContainerSkill](../components/anthropiccontainerskill.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccontainerskill.mdx b/docs/components/anthropiccontainerskill.mdx index 06aea6028..cd23ba0b6 100644 --- a/docs/components/anthropiccontainerskill.mdx +++ b/docs/components/anthropiccontainerskill.mdx @@ -6,6 +6,6 @@ title: "AnthropicContainerSkill" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `skill_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicContainerSkillType](../components/anthropiccontainerskilltype.mdx) | :heavy_check_mark: | N/A | -| `version` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `skill_id` | *str* | ✅ | N/A | +| `type` | [components.AnthropicContainerSkillType](../components/anthropiccontainerskilltype.mdx) | ✅ | N/A | +| `version` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropiccontainerupload.mdx b/docs/components/anthropiccontainerupload.mdx index cc5c98f80..47cdd90fa 100644 --- a/docs/components/anthropiccontainerupload.mdx +++ b/docs/components/anthropiccontainerupload.mdx @@ -6,5 +6,5 @@ title: "AnthropicContainerUpload" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicContainerUploadType](../components/anthropiccontaineruploadtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file_id` | *str* | ✅ | N/A | +| `type` | [components.AnthropicContainerUploadType](../components/anthropiccontaineruploadtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicdirectcaller.mdx b/docs/components/anthropicdirectcaller.mdx index 970780a2c..a685353e2 100644 --- a/docs/components/anthropicdirectcaller.mdx +++ b/docs/components/anthropicdirectcaller.mdx @@ -6,4 +6,4 @@ title: "AnthropicDirectCaller" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnthropicDirectCallerType](../components/anthropicdirectcallertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.AnthropicDirectCallerType](../components/anthropicdirectcallertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicdocumentblock.mdx b/docs/components/anthropicdocumentblock.mdx index 6d9011ff6..8b33d1a19 100644 --- a/docs/components/anthropicdocumentblock.mdx +++ b/docs/components/anthropicdocumentblock.mdx @@ -6,7 +6,7 @@ title: "AnthropicDocumentBlock" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `citations` | [OptionalNullable[components.AnthropicCitationsConfig]](../components/anthropiccitationsconfig.mdx) | :heavy_minus_sign: | N/A | \{
"enabled": true
} | -| `source` | [components.AnthropicDocumentBlockSource](../components/anthropicdocumentblocksource.mdx) | :heavy_check_mark: | N/A | | -| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicDocumentBlockType](../components/anthropicdocumentblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `citations` | [OptionalNullable[components.AnthropicCitationsConfig]](../components/anthropiccitationsconfig.mdx) | ➖ | N/A | \{
"enabled": true
} | +| `source` | [components.AnthropicDocumentBlockSource](../components/anthropicdocumentblocksource.mdx) | ✅ | N/A | | +| `title` | *Nullable[str]* | ✅ | N/A | | +| `type` | [components.AnthropicDocumentBlockType](../components/anthropicdocumentblocktype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicdocumentblockparam.mdx b/docs/components/anthropicdocumentblockparam.mdx index f49b66264..52f444d80 100644 --- a/docs/components/anthropicdocumentblockparam.mdx +++ b/docs/components/anthropicdocumentblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicDocumentBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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[components.AnthropicDocumentBlockParamCitations]](../components/anthropicdocumentblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | -| `context` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `source` | [components.AnthropicDocumentBlockParamSourceUnion](../components/anthropicdocumentblockparamsourceunion.mdx) | :heavy_check_mark: | N/A | | -| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.AnthropicDocumentBlockParamTypeDocument](../components/anthropicdocumentblockparamtypedocument.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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[components.AnthropicDocumentBlockParamCitations]](../components/anthropicdocumentblockparamcitations.mdx) | ➖ | N/A | | +| `context` | *OptionalNullable[str]* | ➖ | N/A | | +| `source` | [components.AnthropicDocumentBlockParamSourceUnion](../components/anthropicdocumentblockparamsourceunion.mdx) | ✅ | N/A | | +| `title` | *OptionalNullable[str]* | ➖ | N/A | | +| `type` | [components.AnthropicDocumentBlockParamTypeDocument](../components/anthropicdocumentblockparamtypedocument.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicdocumentblockparamcitations.mdx b/docs/components/anthropicdocumentblockparamcitations.mdx index c8b4d39a9..e86294f85 100644 --- a/docs/components/anthropicdocumentblockparamcitations.mdx +++ b/docs/components/anthropicdocumentblockparamcitations.mdx @@ -6,4 +6,4 @@ title: "AnthropicDocumentBlockParamCitations" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicencryptedcodeexecutionresult.mdx b/docs/components/anthropicencryptedcodeexecutionresult.mdx index 2f992ca40..5828d7272 100644 --- a/docs/components/anthropicencryptedcodeexecutionresult.mdx +++ b/docs/components/anthropicencryptedcodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicEncryptedCodeExecutionResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `content` | List[[components.AnthropicCodeExecutionOutput](../components/anthropiccodeexecutionoutput.mdx)] | :heavy_check_mark: | N/A | -| `encrypted_stdout` | *str* | :heavy_check_mark: | N/A | -| `return_code` | *int* | :heavy_check_mark: | N/A | -| `stderr` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicEncryptedCodeExecutionResultType](../components/anthropicencryptedcodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | List[[components.AnthropicCodeExecutionOutput](../components/anthropiccodeexecutionoutput.mdx)] | ✅ | N/A | +| `encrypted_stdout` | *str* | ✅ | N/A | +| `return_code` | *int* | ✅ | N/A | +| `stderr` | *str* | ✅ | N/A | +| `type` | [components.AnthropicEncryptedCodeExecutionResultType](../components/anthropicencryptedcodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicfile.mdx b/docs/components/anthropicfile.mdx index 7e1012dc7..ada2b77a9 100644 --- a/docs/components/anthropicfile.mdx +++ b/docs/components/anthropicfile.mdx @@ -9,11 +9,11 @@ A stored file in Anthropic's Files API shape. | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `shape` | [components.AnthropicFileShape](../components/anthropicfileshape.mdx) | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `downloadable` | *bool* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `mime_type` | *str* | :heavy_check_mark: | N/A | -| `size_bytes` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicFileType](../components/anthropicfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [components.AnthropicFileShape](../components/anthropicfileshape.mdx) | ✅ | N/A | +| `created_at` | *str* | ✅ | N/A | +| `downloadable` | *bool* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `mime_type` | *str* | ✅ | N/A | +| `size_bytes` | *int* | ✅ | N/A | +| `type` | [components.AnthropicFileType](../components/anthropicfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicfiledeleted.mdx b/docs/components/anthropicfiledeleted.mdx index 2e4f78952..bd28047a1 100644 --- a/docs/components/anthropicfiledeleted.mdx +++ b/docs/components/anthropicfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in Anthropic's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `shape` | [components.AnthropicFileDeletedShape](../components/anthropicfiledeletedshape.mdx) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicFileDeletedType](../components/anthropicfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [components.AnthropicFileDeletedShape](../components/anthropicfiledeletedshape.mdx) | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `type` | [components.AnthropicFileDeletedType](../components/anthropicfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicfiledocumentsource.mdx b/docs/components/anthropicfiledocumentsource.mdx index 9b1f7560f..395524095 100644 --- a/docs/components/anthropicfiledocumentsource.mdx +++ b/docs/components/anthropicfiledocumentsource.mdx @@ -6,5 +6,5 @@ title: "AnthropicFileDocumentSource" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicFileDocumentSourceType](../components/anthropicfiledocumentsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file_id` | *str* | ✅ | N/A | +| `type` | [components.AnthropicFileDocumentSourceType](../components/anthropicfiledocumentsourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicfilelist.mdx b/docs/components/anthropicfilelist.mdx index 59fc87350..f0cbb8b7c 100644 --- a/docs/components/anthropicfilelist.mdx +++ b/docs/components/anthropicfilelist.mdx @@ -9,8 +9,8 @@ A page of files in Anthropic's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `shape` | [components.AnthropicFileListShape](../components/anthropicfilelistshape.mdx) | :heavy_check_mark: | N/A | -| `data` | List[[components.AnthropicFile](../components/anthropicfile.mdx)] | :heavy_check_mark: | N/A | -| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `has_more` | *bool* | :heavy_check_mark: | N/A | -| `last_id` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [components.AnthropicFileListShape](../components/anthropicfilelistshape.mdx) | ✅ | N/A | +| `data` | List[[components.AnthropicFile](../components/anthropicfile.mdx)] | ✅ | N/A | +| `first_id` | *Nullable[str]* | ✅ | N/A | +| `has_more` | *bool* | ✅ | N/A | +| `last_id` | *Nullable[str]* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicimageblockparam.mdx b/docs/components/anthropicimageblockparam.mdx index 9be25eff1..1cb784d5d 100644 --- a/docs/components/anthropicimageblockparam.mdx +++ b/docs/components/anthropicimageblockparam.mdx @@ -6,6 +6,6 @@ title: "AnthropicImageBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/anthropicimageblockparamsource.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicImageBlockParamType](../components/anthropicimageblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/anthropicimageblockparamsource.mdx) | ✅ | N/A | | +| `type` | [components.AnthropicImageBlockParamType](../components/anthropicimageblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicinputtokensclearatleast.mdx b/docs/components/anthropicinputtokensclearatleast.mdx index 0c85fad24..74ad3d2fa 100644 --- a/docs/components/anthropicinputtokensclearatleast.mdx +++ b/docs/components/anthropicinputtokensclearatleast.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensClearAtLeast" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicInputTokensClearAtLeastType](../components/anthropicinputtokensclearatleasttype.mdx) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.AnthropicInputTokensClearAtLeastType](../components/anthropicinputtokensclearatleasttype.mdx) | ✅ | N/A | +| `value` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicinputtokenstrigger.mdx b/docs/components/anthropicinputtokenstrigger.mdx index 72fe90a57..4662c08a6 100644 --- a/docs/components/anthropicinputtokenstrigger.mdx +++ b/docs/components/anthropicinputtokenstrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensTrigger" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicInputTokensTriggerType](../components/anthropicinputtokenstriggertype.mdx) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.AnthropicInputTokensTriggerType](../components/anthropicinputtokenstriggertype.mdx) | ✅ | N/A | +| `value` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicinputtransformation.mdx b/docs/components/anthropicinputtransformation.mdx index 5eadea136..ec4d4d8ed 100644 --- a/docs/components/anthropicinputtransformation.mdx +++ b/docs/components/anthropicinputtransformation.mdx @@ -9,7 +9,7 @@ A server-side transformation Anthropic applied to the request input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `path` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `reason` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `type` | *str* | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *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[str]* | ➖ | N/A | | +| `reason` | *OptionalNullable[str]* | ➖ | N/A | | +| `type` | *str* | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/anthropiciterationcachecreation.mdx b/docs/components/anthropiciterationcachecreation.mdx index 29b33e64a..0646c4a73 100644 --- a/docs/components/anthropiciterationcachecreation.mdx +++ b/docs/components/anthropiciterationcachecreation.mdx @@ -6,5 +6,5 @@ title: "AnthropicIterationCacheCreation" | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `ephemeral_1h_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `ephemeral_5m_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ephemeral_1h_input_tokens` | *Optional[int]* | ➖ | N/A | +| `ephemeral_5m_input_tokens` | *Optional[int]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicmessageoutputconfig.mdx b/docs/components/anthropicmessageoutputconfig.mdx index c96c40a53..0e323aae4 100644 --- a/docs/components/anthropicmessageoutputconfig.mdx +++ b/docs/components/anthropicmessageoutputconfig.mdx @@ -6,4 +6,4 @@ title: "AnthropicMessageOutputConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.AnthropicOutputEffort]](../components/anthropicoutputeffort.mdx) | :heavy_minus_sign: | N/A | high | \ No newline at end of file +| `effort` | [OptionalNullable[components.AnthropicOutputEffort]](../components/anthropicoutputeffort.mdx) | ➖ | N/A | high | \ No newline at end of file diff --git a/docs/components/anthropicmessageusageiteration.mdx b/docs/components/anthropicmessageusageiteration.mdx index 01ec99b0e..bc0302220 100644 --- a/docs/components/anthropicmessageusageiteration.mdx +++ b/docs/components/anthropicmessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicMessageUsageIteration" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.AnthropicMessageUsageIterationType](../components/anthropicmessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cache_creation_input_tokens` | *Optional[int]* | ➖ | N/A | | +| `cache_read_input_tokens` | *Optional[int]* | ➖ | N/A | | +| `input_tokens` | *Optional[int]* | ➖ | N/A | | +| `output_tokens` | *Optional[int]* | ➖ | N/A | | +| `model` | *Optional[str]* | ➖ | N/A | | +| `type` | [components.AnthropicMessageUsageIterationType](../components/anthropicmessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicoutputtokensdetails.mdx b/docs/components/anthropicoutputtokensdetails.mdx index 5e5317081..cacf5afa8 100644 --- a/docs/components/anthropicoutputtokensdetails.mdx +++ b/docs/components/anthropicoutputtokensdetails.mdx @@ -6,4 +6,4 @@ title: "AnthropicOutputTokensDetails" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `thinking_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `thinking_tokens` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicplaintextsource.mdx b/docs/components/anthropicplaintextsource.mdx index 3a07d04fc..3dd144945 100644 --- a/docs/components/anthropicplaintextsource.mdx +++ b/docs/components/anthropicplaintextsource.mdx @@ -6,6 +6,6 @@ title: "AnthropicPlainTextSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | -| `media_type` | [components.AnthropicPlainTextSourceMediaType](../components/anthropicplaintextsourcemediatype.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicPlainTextSourceType](../components/anthropicplaintextsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *str* | ✅ | N/A | +| `media_type` | [components.AnthropicPlainTextSourceMediaType](../components/anthropicplaintextsourcemediatype.mdx) | ✅ | N/A | +| `type` | [components.AnthropicPlainTextSourceType](../components/anthropicplaintextsourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicredactedthinkingblock.mdx b/docs/components/anthropicredactedthinkingblock.mdx index df0aaeaae..502fdbc55 100644 --- a/docs/components/anthropicredactedthinkingblock.mdx +++ b/docs/components/anthropicredactedthinkingblock.mdx @@ -6,5 +6,5 @@ title: "AnthropicRedactedThinkingBlock" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicRedactedThinkingBlockType](../components/anthropicredactedthinkingblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *str* | ✅ | N/A | +| `type` | [components.AnthropicRedactedThinkingBlockType](../components/anthropicredactedthinkingblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicrefusalstopdetails.mdx b/docs/components/anthropicrefusalstopdetails.mdx index 0b310ef75..38846ce56 100644 --- a/docs/components/anthropicrefusalstopdetails.mdx +++ b/docs/components/anthropicrefusalstopdetails.mdx @@ -9,6 +9,6 @@ Structured information about a refusal | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `category` | [Nullable[components.AnthropicRefusalStopDetailsCategory]](../components/anthropicrefusalstopdetailscategory.mdx) | :heavy_check_mark: | N/A | -| `explanation` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicRefusalStopDetailsType](../components/anthropicrefusalstopdetailstype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `category` | [Nullable[components.AnthropicRefusalStopDetailsCategory]](../components/anthropicrefusalstopdetailscategory.mdx) | ✅ | N/A | +| `explanation` | *Nullable[str]* | ✅ | N/A | +| `type` | [components.AnthropicRefusalStopDetailsType](../components/anthropicrefusalstopdetailstype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicsafeguard.mdx b/docs/components/anthropicsafeguard.mdx index 91de925eb..111457158 100644 --- a/docs/components/anthropicsafeguard.mdx +++ b/docs/components/anthropicsafeguard.mdx @@ -9,6 +9,6 @@ A server-side safeguard Anthropic evaluates alongside the completion | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `classifier_context` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `type` | *str* | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"classifier_context": \{
"permission_mode": "auto",
"v": 1
},
"type": "dangerous_tool_use"
} | \ No newline at end of file +| `classifier_context` | Dict[str, *Any*] | ➖ | N/A | | +| `type` | *str* | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"classifier_context": \{
"permission_mode": "auto",
"v": 1
},
"type": "dangerous_tool_use"
} | \ No newline at end of file diff --git a/docs/components/anthropicsearchresultblockparam.mdx b/docs/components/anthropicsearchresultblockparam.mdx index 89ae1afd5..85ff6950a 100644 --- a/docs/components/anthropicsearchresultblockparam.mdx +++ b/docs/components/anthropicsearchresultblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicSearchResultBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.AnthropicSearchResultBlockParamCitations]](../components/anthropicsearchresultblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | -| `content` | List[[components.AnthropicTextBlockParam](../components/anthropictextblockparam.mdx)] | :heavy_check_mark: | N/A | | -| `source` | *str* | :heavy_check_mark: | N/A | | -| `title` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicSearchResultBlockParamType](../components/anthropicsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.AnthropicSearchResultBlockParamCitations]](../components/anthropicsearchresultblockparamcitations.mdx) | ➖ | N/A | | +| `content` | List[[components.AnthropicTextBlockParam](../components/anthropictextblockparam.mdx)] | ✅ | N/A | | +| `source` | *str* | ✅ | N/A | | +| `title` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicSearchResultBlockParamType](../components/anthropicsearchresultblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicsearchresultblockparamcitations.mdx b/docs/components/anthropicsearchresultblockparamcitations.mdx index 107bda327..9b1c23b03 100644 --- a/docs/components/anthropicsearchresultblockparamcitations.mdx +++ b/docs/components/anthropicsearchresultblockparamcitations.mdx @@ -6,4 +6,4 @@ title: "AnthropicSearchResultBlockParamCitations" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicservertoolusage.mdx b/docs/components/anthropicservertoolusage.mdx index c3f95be74..bad3454c4 100644 --- a/docs/components/anthropicservertoolusage.mdx +++ b/docs/components/anthropicservertoolusage.mdx @@ -6,5 +6,5 @@ title: "AnthropicServerToolUsage" | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `web_fetch_requests` | *int* | :heavy_check_mark: | N/A | -| `web_search_requests` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `web_fetch_requests` | *int* | ✅ | N/A | +| `web_search_requests` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropictextblock.mdx b/docs/components/anthropictextblock.mdx index ac26f79de..7c6f62713 100644 --- a/docs/components/anthropictextblock.mdx +++ b/docs/components/anthropictextblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextBlock" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `citations` | List[[components.AnthropicTextCitation](../components/anthropictextcitation.mdx)] | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicTextBlockType](../components/anthropictextblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `citations` | List[[components.AnthropicTextCitation](../components/anthropictextcitation.mdx)] | ✅ | N/A | +| `text` | *str* | ✅ | N/A | +| `type` | [components.AnthropicTextBlockType](../components/anthropictextblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropictextblockparam.mdx b/docs/components/anthropictextblockparam.mdx index 502d15e61..5bc1a621d 100644 --- a/docs/components/anthropictextblockparam.mdx +++ b/docs/components/anthropictextblockparam.mdx @@ -6,7 +6,7 @@ title: "AnthropicTextBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | List[[components.Citation](../components/citation.mdx)] | :heavy_minus_sign: | N/A | | -| `text` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicTextBlockParamType](../components/anthropictextblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | List[[components.Citation](../components/citation.mdx)] | ➖ | N/A | | +| `text` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicTextBlockParamType](../components/anthropictextblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutioncreateresult.mdx b/docs/components/anthropictexteditorcodeexecutioncreateresult.mdx index 7e94b8f76..f1228b91c 100644 --- a/docs/components/anthropictexteditorcodeexecutioncreateresult.mdx +++ b/docs/components/anthropictexteditorcodeexecutioncreateresult.mdx @@ -6,5 +6,5 @@ title: "AnthropicTextEditorCodeExecutionCreateResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `is_file_update` | *bool* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicTextEditorCodeExecutionCreateResultType](../components/anthropictexteditorcodeexecutioncreateresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `is_file_update` | *bool* | ✅ | N/A | +| `type` | [components.AnthropicTextEditorCodeExecutionCreateResultType](../components/anthropictexteditorcodeexecutioncreateresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx b/docs/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx index cd8b9eeff..f989850cc 100644 --- a/docs/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx +++ b/docs/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx @@ -6,9 +6,9 @@ title: "AnthropicTextEditorCodeExecutionStrReplaceResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `lines` | List[*str*] | :heavy_check_mark: | N/A | -| `new_lines` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `new_start` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `old_lines` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `old_start` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicTextEditorCodeExecutionStrReplaceResultType](../components/anthropictexteditorcodeexecutionstrreplaceresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `lines` | List[*str*] | ✅ | N/A | +| `new_lines` | *Nullable[int]* | ✅ | N/A | +| `new_start` | *Nullable[int]* | ✅ | N/A | +| `old_lines` | *Nullable[int]* | ✅ | N/A | +| `old_start` | *Nullable[int]* | ✅ | N/A | +| `type` | [components.AnthropicTextEditorCodeExecutionStrReplaceResultType](../components/anthropictexteditorcodeexecutionstrreplaceresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutiontoolresult.mdx b/docs/components/anthropictexteditorcodeexecutiontoolresult.mdx index 9c05b4427..da4817358 100644 --- a/docs/components/anthropictexteditorcodeexecutiontoolresult.mdx +++ b/docs/components/anthropictexteditorcodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextEditorCodeExecutionToolResult" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicTextEditorCodeExecutionContent](../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"
} | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicTextEditorCodeExecutionToolResultType](../components/anthropictexteditorcodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [components.AnthropicTextEditorCodeExecutionContent](../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"
} | +| `tool_use_id` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicTextEditorCodeExecutionToolResultType](../components/anthropictexteditorcodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutiontoolresulterror.mdx b/docs/components/anthropictexteditorcodeexecutiontoolresulterror.mdx index c818a4b4c..f79c9d595 100644 --- a/docs/components/anthropictexteditorcodeexecutiontoolresulterror.mdx +++ b/docs/components/anthropictexteditorcodeexecutiontoolresulterror.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextEditorCodeExecutionToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `error_code` | [components.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../components/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `error_message` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicTextEditorCodeExecutionToolResultErrorType](../components/anthropictexteditorcodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error_code` | [components.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../components/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `error_message` | *Nullable[str]* | ✅ | N/A | +| `type` | [components.AnthropicTextEditorCodeExecutionToolResultErrorType](../components/anthropictexteditorcodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropictexteditorcodeexecutionviewresult.mdx b/docs/components/anthropictexteditorcodeexecutionviewresult.mdx index f1fe04cac..cba28c9df 100644 --- a/docs/components/anthropictexteditorcodeexecutionviewresult.mdx +++ b/docs/components/anthropictexteditorcodeexecutionviewresult.mdx @@ -6,9 +6,9 @@ title: "AnthropicTextEditorCodeExecutionViewResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `content` | *str* | :heavy_check_mark: | N/A | -| `file_type` | [components.FileType](../components/filetype.mdx) | :heavy_check_mark: | N/A | -| `num_lines` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `start_line` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `total_lines` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicTextEditorCodeExecutionViewResultType](../components/anthropictexteditorcodeexecutionviewresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *str* | ✅ | N/A | +| `file_type` | [components.FileType](../components/filetype.mdx) | ✅ | N/A | +| `num_lines` | *Nullable[int]* | ✅ | N/A | +| `start_line` | *Nullable[int]* | ✅ | N/A | +| `total_lines` | *Nullable[int]* | ✅ | N/A | +| `type` | [components.AnthropicTextEditorCodeExecutionViewResultType](../components/anthropictexteditorcodeexecutionviewresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicthinkingblock.mdx b/docs/components/anthropicthinkingblock.mdx index 7ca58e1c0..2f9d95c4e 100644 --- a/docs/components/anthropicthinkingblock.mdx +++ b/docs/components/anthropicthinkingblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicThinkingBlock" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `signature` | *str* | :heavy_check_mark: | N/A | -| `thinking` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicThinkingBlockType](../components/anthropicthinkingblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `signature` | *str* | ✅ | N/A | +| `thinking` | *str* | ✅ | N/A | +| `type` | [components.AnthropicThinkingBlockType](../components/anthropicthinkingblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicthinkingblockbinding.mdx b/docs/components/anthropicthinkingblockbinding.mdx index cc9f8e6a2..8f259847b 100644 --- a/docs/components/anthropicthinkingblockbinding.mdx +++ b/docs/components/anthropicthinkingblockbinding.mdx @@ -6,5 +6,5 @@ title: "AnthropicThinkingBlockBinding" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ~~`mismatch_behavior`~~ | [OptionalNullable[components.MismatchBehavior]](../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. | -| `prefix_mismatch_behavior` | [OptionalNullable[components.PrefixMismatchBehavior]](../components/prefixmismatchbehavior.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| ~~`mismatch_behavior`~~ | [OptionalNullable[components.MismatchBehavior]](../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. | +| `prefix_mismatch_behavior` | [OptionalNullable[components.PrefixMismatchBehavior]](../components/prefixmismatchbehavior.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicthinkingturns.mdx b/docs/components/anthropicthinkingturns.mdx index 9c9202152..d4c53fd01 100644 --- a/docs/components/anthropicthinkingturns.mdx +++ b/docs/components/anthropicthinkingturns.mdx @@ -6,5 +6,5 @@ title: "AnthropicThinkingTurns" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.AnthropicThinkingTurnsType](../components/anthropicthinkingturnstype.mdx) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.AnthropicThinkingTurnsType](../components/anthropicthinkingturnstype.mdx) | ✅ | N/A | +| `value` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropictoolreference.mdx b/docs/components/anthropictoolreference.mdx index ee8d6b278..cece19a06 100644 --- a/docs/components/anthropictoolreference.mdx +++ b/docs/components/anthropictoolreference.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `tool_name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicToolReferenceType](../components/anthropictoolreferencetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `tool_name` | *str* | ✅ | N/A | +| `type` | [components.AnthropicToolReferenceType](../components/anthropictoolreferencetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchresult.mdx b/docs/components/anthropictoolsearchresult.mdx index 69a738d24..22a5297af 100644 --- a/docs/components/anthropictoolsearchresult.mdx +++ b/docs/components/anthropictoolsearchresult.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolSearchResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `tool_references` | List[[components.AnthropicToolReference](../components/anthropictoolreference.mdx)] | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicToolSearchResultType](../components/anthropictoolsearchresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `tool_references` | List[[components.AnthropicToolReference](../components/anthropictoolreference.mdx)] | ✅ | N/A | +| `type` | [components.AnthropicToolSearchResultType](../components/anthropictoolsearchresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchresulterror.mdx b/docs/components/anthropictoolsearchresulterror.mdx index 1e624f118..702eaaa28 100644 --- a/docs/components/anthropictoolsearchresulterror.mdx +++ b/docs/components/anthropictoolsearchresulterror.mdx @@ -6,6 +6,6 @@ title: "AnthropicToolSearchResultError" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `error_code` | [components.AnthropicServerToolErrorCode](../components/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | -| `error_message` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicToolSearchResultErrorType](../components/anthropictoolsearchresulterrortype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `error_code` | [components.AnthropicServerToolErrorCode](../components/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | +| `error_message` | *Nullable[str]* | ✅ | N/A | | +| `type` | [components.AnthropicToolSearchResultErrorType](../components/anthropictoolsearchresulterrortype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchtoolbm25.mdx b/docs/components/anthropictoolsearchtoolbm25.mdx index 0481dd033..3b2423fb2 100644 --- a/docs/components/anthropictoolsearchtoolbm25.mdx +++ b/docs/components/anthropictoolsearchtoolbm25.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolBm25" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `name` | [components.AnthropicToolSearchToolBm25Name](../components/anthropictoolsearchtoolbm25name.mdx) | :heavy_check_mark: | N/A | | -| `strict` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `type` | [components.AnthropicToolSearchToolBm25Type](../components/anthropictoolsearchtoolbm25type.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | ➖ | N/A | [
"direct"
] | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `defer_loading` | *Optional[bool]* | ➖ | N/A | | +| `name` | [components.AnthropicToolSearchToolBm25Name](../components/anthropictoolsearchtoolbm25name.mdx) | ✅ | N/A | | +| `strict` | *Optional[bool]* | ➖ | N/A | | +| `type` | [components.AnthropicToolSearchToolBm25Type](../components/anthropictoolsearchtoolbm25type.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchtoolregex.mdx b/docs/components/anthropictoolsearchtoolregex.mdx index 9eaa23460..dd71f6ade 100644 --- a/docs/components/anthropictoolsearchtoolregex.mdx +++ b/docs/components/anthropictoolsearchtoolregex.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolRegex" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `name` | [components.AnthropicToolSearchToolRegexName](../components/anthropictoolsearchtoolregexname.mdx) | :heavy_check_mark: | N/A | | -| `strict` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `type` | [components.AnthropicToolSearchToolRegexType](../components/anthropictoolsearchtoolregextype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | ➖ | N/A | [
"direct"
] | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `defer_loading` | *Optional[bool]* | ➖ | N/A | | +| `name` | [components.AnthropicToolSearchToolRegexName](../components/anthropictoolsearchtoolregexname.mdx) | ✅ | N/A | | +| `strict` | *Optional[bool]* | ➖ | N/A | | +| `type` | [components.AnthropicToolSearchToolRegexType](../components/anthropictoolsearchtoolregextype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictoolsearchtoolresult.mdx b/docs/components/anthropictoolsearchtoolresult.mdx index 191c13c22..6efe83646 100644 --- a/docs/components/anthropictoolsearchtoolresult.mdx +++ b/docs/components/anthropictoolsearchtoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicToolSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicToolSearchContent](../components/anthropictoolsearchcontent.mdx) | :heavy_check_mark: | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicToolSearchToolResultType](../components/anthropictoolsearchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [components.AnthropicToolSearchContent](../components/anthropictoolsearchcontent.mdx) | ✅ | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | +| `tool_use_id` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicToolSearchToolResultType](../components/anthropictoolsearchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictooluseblock.mdx b/docs/components/anthropictooluseblock.mdx index 51bc60d20..8f4e92fa8 100644 --- a/docs/components/anthropictooluseblock.mdx +++ b/docs/components/anthropictooluseblock.mdx @@ -6,8 +6,8 @@ title: "AnthropicToolUseBlock" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `input` | *Optional[Any]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicToolUseBlockType](../components/anthropictooluseblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | +| `id` | *str* | ✅ | N/A | | +| `input` | *Optional[Any]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicToolUseBlockType](../components/anthropictooluseblocktype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropictooluseskeep.mdx b/docs/components/anthropictooluseskeep.mdx index 56a3b082a..a552a6104 100644 --- a/docs/components/anthropictooluseskeep.mdx +++ b/docs/components/anthropictooluseskeep.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesKeep" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnthropicToolUsesKeepType](../components/anthropictooluseskeeptype.mdx) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.AnthropicToolUsesKeepType](../components/anthropictooluseskeeptype.mdx) | ✅ | N/A | +| `value` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropictoolusestrigger.mdx b/docs/components/anthropictoolusestrigger.mdx index ddf146336..7a62403e9 100644 --- a/docs/components/anthropictoolusestrigger.mdx +++ b/docs/components/anthropictoolusestrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesTrigger" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicToolUsesTriggerType](../components/anthropictoolusestriggertype.mdx) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.AnthropicToolUsesTriggerType](../components/anthropictoolusestriggertype.mdx) | ✅ | N/A | +| `value` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicunknownusageiteration.mdx b/docs/components/anthropicunknownusageiteration.mdx index 9a298f507..9571ae700 100644 --- a/docs/components/anthropicunknownusageiteration.mdx +++ b/docs/components/anthropicunknownusageiteration.mdx @@ -6,9 +6,9 @@ title: "AnthropicUnknownUsageIteration" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cache_creation_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `cache_read_input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `type` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicIterationCacheCreation]](../components/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cache_creation_input_tokens` | *Optional[int]* | ➖ | N/A | | +| `cache_read_input_tokens` | *Optional[int]* | ➖ | N/A | | +| `input_tokens` | *Optional[int]* | ➖ | N/A | | +| `output_tokens` | *Optional[int]* | ➖ | N/A | | +| `type` | *str* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicurlimagesource.mdx b/docs/components/anthropicurlimagesource.mdx index ac9136051..da55e53d6 100644 --- a/docs/components/anthropicurlimagesource.mdx +++ b/docs/components/anthropicurlimagesource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLImageSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicURLImageSourceType](../components/anthropicurlimagesourcetype.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.AnthropicURLImageSourceType](../components/anthropicurlimagesourcetype.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicurlpdfsource.mdx b/docs/components/anthropicurlpdfsource.mdx index 50d60b95a..21d429202 100644 --- a/docs/components/anthropicurlpdfsource.mdx +++ b/docs/components/anthropicurlpdfsource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLPdfSource" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnthropicURLPdfSourceType](../components/anthropicurlpdfsourcetype.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.AnthropicURLPdfSourceType](../components/anthropicurlpdfsourcetype.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebfetchblock.mdx b/docs/components/anthropicwebfetchblock.mdx index e130a5784..d0f33b835 100644 --- a/docs/components/anthropicwebfetchblock.mdx +++ b/docs/components/anthropicwebfetchblock.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebFetchBlock" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [components.AnthropicDocumentBlock](../components/anthropicdocumentblock.mdx) | :heavy_check_mark: | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | -| `retrieved_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicWebFetchBlockType](../components/anthropicwebfetchblocktype.mdx) | :heavy_check_mark: | N/A | | -| `url` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [components.AnthropicDocumentBlock](../components/anthropicdocumentblock.mdx) | ✅ | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | +| `retrieved_at` | *Nullable[str]* | ✅ | N/A | | +| `type` | [components.AnthropicWebFetchBlockType](../components/anthropicwebfetchblocktype.mdx) | ✅ | N/A | | +| `url` | *str* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicwebfetchtoolresult.mdx b/docs/components/anthropicwebfetchtoolresult.mdx index d33f72fbf..db198b593 100644 --- a/docs/components/anthropicwebfetchtoolresult.mdx +++ b/docs/components/anthropicwebfetchtoolresult.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebFetchToolResult" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | -| `content` | [components.AnthropicWebFetchContent](../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"
} | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicWebFetchToolResultType](../components/anthropicwebfetchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | +| `content` | [components.AnthropicWebFetchContent](../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"
} | +| `tool_use_id` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicWebFetchToolResultType](../components/anthropicwebfetchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicwebfetchtoolresulterror.mdx b/docs/components/anthropicwebfetchtoolresulterror.mdx index 3b9150ee7..1b9ea9f31 100644 --- a/docs/components/anthropicwebfetchtoolresulterror.mdx +++ b/docs/components/anthropicwebfetchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicWebFetchToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `error_code` | [components.AnthropicWebFetchToolResultErrorErrorCode](../components/anthropicwebfetchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicWebFetchToolResultErrorType](../components/anthropicwebfetchtoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error_code` | [components.AnthropicWebFetchToolResultErrorErrorCode](../components/anthropicwebfetchtoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `type` | [components.AnthropicWebFetchToolResultErrorType](../components/anthropicwebfetchtoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchresult.mdx b/docs/components/anthropicwebsearchresult.mdx index 9f44a3136..510a38e9b 100644 --- a/docs/components/anthropicwebsearchresult.mdx +++ b/docs/components/anthropicwebsearchresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `encrypted_content` | *str* | :heavy_check_mark: | N/A | -| `page_age` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicWebSearchResultType](../components/anthropicwebsearchresulttype.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `encrypted_content` | *str* | ✅ | N/A | +| `page_age` | *Nullable[str]* | ✅ | N/A | +| `title` | *str* | ✅ | N/A | +| `type` | [components.AnthropicWebSearchResultType](../components/anthropicwebsearchresulttype.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchresultblockparam.mdx b/docs/components/anthropicwebsearchresultblockparam.mdx index ddcfad396..0da915149 100644 --- a/docs/components/anthropicwebsearchresultblockparam.mdx +++ b/docs/components/anthropicwebsearchresultblockparam.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchResultBlockParam" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `encrypted_content` | *str* | :heavy_check_mark: | N/A | -| `page_age` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicWebSearchResultBlockParamType](../components/anthropicwebsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `encrypted_content` | *str* | ✅ | N/A | +| `page_age` | *OptionalNullable[str]* | ➖ | N/A | +| `title` | *str* | ✅ | N/A | +| `type` | [components.AnthropicWebSearchResultBlockParamType](../components/anthropicwebsearchresultblockparamtype.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchtoolresult.mdx b/docs/components/anthropicwebsearchtoolresult.mdx index 52ae78a27..1a3a9898c 100644 --- a/docs/components/anthropicwebsearchtoolresult.mdx +++ b/docs/components/anthropicwebsearchtoolresult.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | -| `content` | [components.AnthropicWebSearchToolResultContent](../components/anthropicwebsearchtoolresultcontent.mdx) | :heavy_check_mark: | N/A | | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicWebSearchToolResultType](../components/anthropicwebsearchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `caller` | [components.AnthropicCaller](../components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | +| `content` | [components.AnthropicWebSearchToolResultContent](../components/anthropicwebsearchtoolresultcontent.mdx) | ✅ | N/A | | +| `tool_use_id` | *str* | ✅ | N/A | | +| `type` | [components.AnthropicWebSearchToolResultType](../components/anthropicwebsearchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchtoolresulterror.mdx b/docs/components/anthropicwebsearchtoolresulterror.mdx index 7b7cb1372..6659aefb1 100644 --- a/docs/components/anthropicwebsearchtoolresulterror.mdx +++ b/docs/components/anthropicwebsearchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicWebSearchToolResultError" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `error_code` | [components.AnthropicWebSearchToolResultErrorErrorCode](../components/anthropicwebsearchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicWebSearchToolResultErrorType](../components/anthropicwebsearchtoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error_code` | [components.AnthropicWebSearchToolResultErrorErrorCode](../components/anthropicwebsearchtoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `type` | [components.AnthropicWebSearchToolResultErrorType](../components/anthropicwebsearchtoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/anthropicwebsearchtooluserlocation.mdx b/docs/components/anthropicwebsearchtooluserlocation.mdx index 0096c9dc4..cc8014ba5 100644 --- a/docs/components/anthropicwebsearchtooluserlocation.mdx +++ b/docs/components/anthropicwebsearchtooluserlocation.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchToolUserLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.AnthropicWebSearchToolUserLocationType](../components/anthropicwebsearchtooluserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | ➖ | N/A | +| `country` | *OptionalNullable[str]* | ➖ | N/A | +| `region` | *OptionalNullable[str]* | ➖ | N/A | +| `timezone` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.AnthropicWebSearchToolUserLocationType](../components/anthropicwebsearchtooluserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/applypatchcallitem.mdx b/docs/components/applypatchcallitem.mdx index 69bc2b864..07943aac8 100644 --- a/docs/components/applypatchcallitem.mdx +++ b/docs/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 | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `operation` | [components.ApplyPatchCallOperation](../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](../components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | [components.ApplyPatchCallItemType](../components/applypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `operation` | [components.ApplyPatchCallOperation](../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](../components/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | +| `type` | [components.ApplyPatchCallItemType](../components/applypatchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/applypatchcalloperationdiffdeltaevent.mdx b/docs/components/applypatchcalloperationdiffdeltaevent.mdx index d8c4af6ac..5f0581c56 100644 --- a/docs/components/applypatchcalloperationdiffdeltaevent.mdx +++ b/docs/components/applypatchcalloperationdiffdeltaevent.mdx @@ -9,8 +9,8 @@ Incremental chunk of `operation.diff` for an `apply_patch_call`. Matches OpenAI' | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../components/applypatchcalloperationdiffdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../components/applypatchcalloperationdiffdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/applypatchcalloperationdiffdoneevent.mdx b/docs/components/applypatchcalloperationdiffdoneevent.mdx index c722bd495..44a387527 100644 --- a/docs/components/applypatchcalloperationdiffdoneevent.mdx +++ b/docs/components/applypatchcalloperationdiffdoneevent.mdx @@ -9,8 +9,8 @@ Emitted when `operation.diff` streaming completes for an `apply_patch_call`. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `diff` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchCallOperationDiffDoneEventType](../components/applypatchcalloperationdiffdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `diff` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ApplyPatchCallOperationDiffDoneEventType](../components/applypatchcalloperationdiffdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/applypatchcalloutputitem.mdx b/docs/components/applypatchcalloutputitem.mdx index 6ef61a86a..4195ba13c 100644 --- a/docs/components/applypatchcalloutputitem.mdx +++ b/docs/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 | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `output` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `status` | [components.ApplyPatchCallOutputItemStatus](../components/applypatchcalloutputitemstatus.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchCallOutputItemType](../components/applypatchcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | +| `id` | *OptionalNullable[str]* | ➖ | N/A | +| `output` | *OptionalNullable[str]* | ➖ | N/A | +| `status` | [components.ApplyPatchCallOutputItemStatus](../components/applypatchcalloutputitemstatus.mdx) | ✅ | N/A | +| `type` | [components.ApplyPatchCallOutputItemType](../components/applypatchcalloutputitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/applypatchcreatefileoperation.mdx b/docs/components/applypatchcreatefileoperation.mdx index 37aa1921b..54000e705 100644 --- a/docs/components/applypatchcreatefileoperation.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | N/A | -| `path` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchCreateFileOperationType](../components/applypatchcreatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `diff` | *str* | ✅ | N/A | +| `path` | *str* | ✅ | N/A | +| `type` | [components.ApplyPatchCreateFileOperationType](../components/applypatchcreatefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/applypatchdeletefileoperation.mdx b/docs/components/applypatchdeletefileoperation.mdx index 49463ffa8..5c398f64a 100644 --- a/docs/components/applypatchdeletefileoperation.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchDeleteFileOperationType](../components/applypatchdeletefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `path` | *str* | ✅ | N/A | +| `type` | [components.ApplyPatchDeleteFileOperationType](../components/applypatchdeletefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/applypatchservertool.mdx b/docs/components/applypatchservertool.mdx index b8c80524b..63069c30e 100644 --- a/docs/components/applypatchservertool.mdx +++ b/docs/components/applypatchservertool.mdx @@ -9,4 +9,4 @@ Apply patch tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.ApplyPatchServerToolType](../components/applypatchservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.ApplyPatchServerToolType](../components/applypatchservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/applypatchservertoolconfig.mdx b/docs/components/applypatchservertoolconfig.mdx index 1ec1793d3..b8aa5b714 100644 --- a/docs/components/applypatchservertoolconfig.mdx +++ b/docs/components/applypatchservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:apply_patch server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [Optional[components.ApplyPatchEngineEnum]](../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` | [Optional[components.ApplyPatchEngineEnum]](../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/components/applypatchservertoolopenrouter.mdx b/docs/components/applypatchservertoolopenrouter.mdx index 98531bfb7..b4bfb5e5f 100644 --- a/docs/components/applypatchservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.ApplyPatchServerToolConfig]](../components/applypatchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | -| `type` | [components.ApplyPatchServerToolOpenRouterType](../components/applypatchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.ApplyPatchServerToolConfig]](../components/applypatchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | +| `type` | [components.ApplyPatchServerToolOpenRouterType](../components/applypatchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/applypatchupdatefileoperation.mdx b/docs/components/applypatchupdatefileoperation.mdx index 458f78672..2a31fac7c 100644 --- a/docs/components/applypatchupdatefileoperation.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | N/A | -| `path` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchUpdateFileOperationType](../components/applypatchupdatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `diff` | *str* | ✅ | N/A | +| `path` | *str* | ✅ | N/A | +| `type` | [components.ApplyPatchUpdateFileOperationType](../components/applypatchupdatefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/apprankingsitem.mdx b/docs/components/apprankingsitem.mdx index 08cc35c0a..996f21627 100644 --- a/docs/components/apprankingsitem.mdx +++ b/docs/components/apprankingsitem.mdx @@ -6,8 +6,8 @@ title: "AppRankingsItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `app_id` | *int* | :heavy_check_mark: | Stable numeric identifier of the app on OpenRouter. | 12345 | -| `app_name` | *str* | :heavy_check_mark: | Public display name of the app. | Cline | -| `rank` | *int* | :heavy_check_mark: | 1-based position of the app within this response, per the requested `sort`. | 1 | -| `total_requests` | *int* | :heavy_check_mark: | Number of requests attributed to the app inside the date window. | 4321 | -| `total_tokens` | *str* | :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 +| `app_id` | *int* | ✅ | Stable numeric identifier of the app on OpenRouter. | 12345 | +| `app_name` | *str* | ✅ | Public display name of the app. | Cline | +| `rank` | *int* | ✅ | 1-based position of the app within this response, per the requested `sort`. | 1 | +| `total_requests` | *int* | ✅ | Number of requests attributed to the app inside the date window. | 4321 | +| `total_tokens` | *str* | ✅ | 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/components/apprankingsresponse.mdx b/docs/components/apprankingsresponse.mdx index dd7310f00..b3486dca4 100644 --- a/docs/components/apprankingsresponse.mdx +++ b/docs/components/apprankingsresponse.mdx @@ -6,5 +6,5 @@ title: "AppRankingsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | List[[components.AppRankingsItem](../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](../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` | List[[components.AppRankingsItem](../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](../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/components/architecture.mdx b/docs/components/architecture.mdx index 1c451e3fe..953efa605 100644 --- a/docs/components/architecture.mdx +++ b/docs/components/architecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `input_modalities` | List[[components.InputModality](../components/inputmodality.mdx)] | :heavy_check_mark: | Supported input modalities | | -| `instruct_type` | [Nullable[components.InstructType]](../components/instructtype.mdx) | :heavy_check_mark: | Instruction format type | chatml | -| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text | -| `output_modalities` | List[[components.OutputModality](../components/outputmodality.mdx)] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [Nullable[components.ModelGroup]](../components/modelgroup.mdx) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file +| `input_modalities` | List[[components.InputModality](../components/inputmodality.mdx)] | ✅ | Supported input modalities | | +| `instruct_type` | [Nullable[components.InstructType]](../components/instructtype.mdx) | ✅ | Instruction format type | chatml | +| `modality` | *Nullable[str]* | ✅ | Primary modality of the model | text | +| `output_modalities` | List[[components.OutputModality](../components/outputmodality.mdx)] | ✅ | Supported output modalities | | +| `tokenizer` | [Nullable[components.ModelGroup]](../components/modelgroup.mdx) | ✅ | N/A | GPT | \ No newline at end of file diff --git a/docs/components/audiourl.mdx b/docs/components/audiourl.mdx index ef98b1de4..2a5d649d0 100644 --- a/docs/components/audiourl.mdx +++ b/docs/components/audiourl.mdx @@ -6,4 +6,4 @@ title: "AudioURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/autobetarouterplugin.mdx b/docs/components/autobetarouterplugin.mdx index d361141a0..4a844e501 100644 --- a/docs/components/autobetarouterplugin.mdx +++ b/docs/components/autobetarouterplugin.mdx @@ -6,9 +6,9 @@ title: "AutoBetaRouterPlugin" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | :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/*"
] | -| ~~`cost_quality_tradeoff`~~ | *Optional[int]* | :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 | -| `cost_tier` | [Optional[components.AutoBetaRouterPluginCostTier]](../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` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | -| `excluded_models` | List[*str*] | :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](../components/autobetarouterpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowed_models` | List[*str*] | ➖ | 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/*"
] | +| ~~`cost_quality_tradeoff`~~ | *Optional[int]* | ➖ | : 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 | +| `cost_tier` | [Optional[components.AutoBetaRouterPluginCostTier]](../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` | *Optional[bool]* | ➖ | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | +| `excluded_models` | List[*str*] | ➖ | 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](../components/autobetarouterpluginid.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/autorouterplugin.mdx b/docs/components/autorouterplugin.mdx index 682200794..6a9ad0505 100644 --- a/docs/components/autorouterplugin.mdx +++ b/docs/components/autorouterplugin.mdx @@ -6,10 +6,10 @@ title: "AutoRouterPlugin" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | :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/*"
] | -| ~~`cost_quality_tradeoff`~~ | *Optional[int]* | :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 | -| `cost_tier` | [Optional[components.AutoRouterPluginCostTier]](../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` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `excluded_models` | List[*str*] | :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](../components/autorouterpluginid.mdx) | :heavy_check_mark: | N/A | | -| `pin_model` | *Optional[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 +| `allowed_models` | List[*str*] | ➖ | 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/*"
] | +| ~~`cost_quality_tradeoff`~~ | *Optional[int]* | ➖ | : 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 | +| `cost_tier` | [Optional[components.AutoRouterPluginCostTier]](../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` | *Optional[bool]* | ➖ | Set to false to disable the auto-router plugin for this request. Defaults to true. | | +| `excluded_models` | List[*str*] | ➖ | 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](../components/autorouterpluginid.mdx) | ✅ | N/A | | +| `pin_model` | *Optional[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/components/badgatewayresponseerrordata.mdx b/docs/components/badgatewayresponseerrordata.mdx index 2a37f6808..5c9efedb5 100644 --- a/docs/components/badgatewayresponseerrordata.mdx +++ b/docs/components/badgatewayresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for BadGatewayResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/badrequestresponseerrordata.mdx b/docs/components/badrequestresponseerrordata.mdx index 3fa8d9508..da9f6a079 100644 --- a/docs/components/badrequestresponseerrordata.mdx +++ b/docs/components/badrequestresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for BadRequestResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/baseinputsmessage.mdx b/docs/components/baseinputsmessage.mdx index 0c00444a9..9b21b0026 100644 --- a/docs/components/baseinputsmessage.mdx +++ b/docs/components/baseinputsmessage.mdx @@ -6,7 +6,7 @@ title: "BaseInputsMessage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content` | [components.BaseInputsContent2](../components/baseinputscontent2.mdx) | :heavy_check_mark: | N/A | -| `phase` | [OptionalNullable[components.BaseInputsPhaseUnion]](../components/baseinputsphaseunion.mdx) | :heavy_minus_sign: | N/A | -| `role` | [components.BaseInputsRoleUnion](../components/baseinputsroleunion.mdx) | :heavy_check_mark: | N/A | -| `type` | [Optional[components.BaseInputsType]](../components/baseinputstype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | [components.BaseInputsContent2](../components/baseinputscontent2.mdx) | ✅ | N/A | +| `phase` | [OptionalNullable[components.BaseInputsPhaseUnion]](../components/baseinputsphaseunion.mdx) | ➖ | N/A | +| `role` | [components.BaseInputsRoleUnion](../components/baseinputsroleunion.mdx) | ✅ | N/A | +| `type` | [Optional[components.BaseInputsType]](../components/baseinputstype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/basereasoningconfig.mdx b/docs/components/basereasoningconfig.mdx index 6f900a92f..4e05525ed 100644 --- a/docs/components/basereasoningconfig.mdx +++ b/docs/components/basereasoningconfig.mdx @@ -6,7 +6,7 @@ title: "BaseReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context` | [OptionalNullable[components.ReasoningContext]](../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[components.ReasoningEffort]](../components/reasoningeffort.mdx) | :heavy_minus_sign: | N/A | medium | -| `mode` | [OptionalNullable[components.ReasoningMode]](../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[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.mdx) | :heavy_minus_sign: | N/A | auto | \ No newline at end of file +| `context` | [OptionalNullable[components.ReasoningContext]](../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[components.ReasoningEffort]](../components/reasoningeffort.mdx) | ➖ | N/A | medium | +| `mode` | [OptionalNullable[components.ReasoningMode]](../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[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.mdx) | ➖ | N/A | auto | \ No newline at end of file diff --git a/docs/components/bashservertool.mdx b/docs/components/bashservertool.mdx index 09464da84..3727711ec 100644 --- a/docs/components/bashservertool.mdx +++ b/docs/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` | [Optional[components.BashServerToolConfig]](../components/bashservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | -| `type` | [components.BashServerToolType](../components/bashservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.BashServerToolConfig]](../components/bashservertoolconfig.mdx) | ➖ | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | +| `type` | [components.BashServerToolType](../components/bashservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/bashservertoolconfig.mdx b/docs/components/bashservertoolconfig.mdx index 8fba79f13..74532a4fd 100644 --- a/docs/components/bashservertoolconfig.mdx +++ b/docs/components/bashservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:bash server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [Optional[components.BashServerToolEngine]](../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` | [Optional[components.BashServerToolEnvironment]](../components/bashservertoolenvironment.mdx) | :heavy_minus_sign: | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | \ No newline at end of file +| `engine` | [Optional[components.BashServerToolEngine]](../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` | [Optional[components.BashServerToolEnvironment]](../components/bashservertoolenvironment.mdx) | ➖ | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | \ No newline at end of file diff --git a/docs/components/batchdeletedobject.mdx b/docs/components/batchdeletedobject.mdx index 9c7da3ad2..3fe356bdb 100644 --- a/docs/components/batchdeletedobject.mdx +++ b/docs/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](../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` | *str* | :heavy_check_mark: | N/A | batch_abc123 | -| `object` | [components.BatchDeletedObjectObject](../components/batchdeletedobjectobject.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `deletion` | [components.BatchDeletionTargets](../components/batchdeletiontargets.mdx) | ✅ | OpenRouter cleanup and, when a provider was assigned, the upstream batch deletion outcome. | \{
"openrouter": "deleted",
"upstream": \{
"provider": "Anthropic",
"status": "deleted"
}
} | +| `id` | *str* | ✅ | N/A | batch_abc123 | +| `object` | [components.BatchDeletedObjectObject](../components/batchdeletedobjectobject.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/batchdeletiontargets.mdx b/docs/components/batchdeletiontargets.mdx index 70b3c642c..4a99b661e 100644 --- a/docs/components/batchdeletiontargets.mdx +++ b/docs/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](../components/openrouter.mdx) | :heavy_check_mark: | OpenRouter-held request and result artifacts were purged. | -| `upstream` | [Optional[components.Upstream]](../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](../components/openrouter.mdx) | ✅ | OpenRouter-held request and result artifacts were purged. | +| `upstream` | [Optional[components.Upstream]](../components/upstream.mdx) | ➖ | The upstream batch deletion outcome; omitted when no provider was assigned. | \ No newline at end of file diff --git a/docs/components/batcherrorresponseerror.mdx b/docs/components/batcherrorresponseerror.mdx index 230a7c61a..89fe9721c 100644 --- a/docs/components/batcherrorresponseerror.mdx +++ b/docs/components/batcherrorresponseerror.mdx @@ -6,5 +6,5 @@ title: "BatchErrorResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchlistitem.mdx b/docs/components/batchlistitem.mdx index 7a39aba9b..25a253795 100644 --- a/docs/components/batchlistitem.mdx +++ b/docs/components/batchlistitem.mdx @@ -9,15 +9,15 @@ Metadata-only batch object. `results` is always `null` in list responses. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `completion_window` | [components.BatchListItemCompletionWindow](../components/batchlistitemcompletionwindow.mdx) | :heavy_check_mark: | N/A | -| `created_at` | *int* | :heavy_check_mark: | N/A | -| `endpoint` | *str* | :heavy_check_mark: | N/A | -| `error` | [Nullable[components.BatchListItemError]](../components/batchlistitemerror.mdx) | :heavy_check_mark: | N/A | -| `finalized_at` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `object` | [components.BatchListItemObject](../components/batchlistitemobject.mdx) | :heavy_check_mark: | N/A | -| `request_counts` | [components.BatchListItemRequestCounts](../components/batchlistitemrequestcounts.mdx) | :heavy_check_mark: | N/A | -| `results` | *Nullable[Any]* | :heavy_check_mark: | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | -| `status` | [components.BatchListItemStatus](../components/batchlistitemstatus.mdx) | :heavy_check_mark: | N/A | -| `usage` | [Nullable[components.BatchListItemUsage]](../components/batchlistitemusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `completion_window` | [components.BatchListItemCompletionWindow](../components/batchlistitemcompletionwindow.mdx) | ✅ | N/A | +| `created_at` | *int* | ✅ | N/A | +| `endpoint` | *str* | ✅ | N/A | +| `error` | [Nullable[components.BatchListItemError]](../components/batchlistitemerror.mdx) | ✅ | N/A | +| `finalized_at` | *Nullable[int]* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `model` | *str* | ✅ | N/A | +| `object` | [components.BatchListItemObject](../components/batchlistitemobject.mdx) | ✅ | N/A | +| `request_counts` | [components.BatchListItemRequestCounts](../components/batchlistitemrequestcounts.mdx) | ✅ | N/A | +| `results` | *Nullable[Any]* | ✅ | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | +| `status` | [components.BatchListItemStatus](../components/batchlistitemstatus.mdx) | ✅ | N/A | +| `usage` | [Nullable[components.BatchListItemUsage]](../components/batchlistitemusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchlistitemcompletiontokensdetails.mdx b/docs/components/batchlistitemcompletiontokensdetails.mdx index 769284c9d..b220f29b4 100644 --- a/docs/components/batchlistitemcompletiontokensdetails.mdx +++ b/docs/components/batchlistitemcompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchListItemCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/batchlistitemerror.mdx b/docs/components/batchlistitemerror.mdx index 1891de192..68326f504 100644 --- a/docs/components/batchlistitemerror.mdx +++ b/docs/components/batchlistitemerror.mdx @@ -6,4 +6,4 @@ title: "BatchListItemError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `message` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchlistitemprompttokensdetails.mdx b/docs/components/batchlistitemprompttokensdetails.mdx index 6da3113ea..03e67cf92 100644 --- a/docs/components/batchlistitemprompttokensdetails.mdx +++ b/docs/components/batchlistitemprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/batchlistitemrequestcounts.mdx b/docs/components/batchlistitemrequestcounts.mdx index 695a4266b..6df200a13 100644 --- a/docs/components/batchlistitemrequestcounts.mdx +++ b/docs/components/batchlistitemrequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchListItemRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `completed` | *int* | :heavy_check_mark: | N/A | -| `failed` | *int* | :heavy_check_mark: | N/A | -| `total` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `completed` | *int* | ✅ | N/A | +| `failed` | *int* | ✅ | N/A | +| `total` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchlistitemservertooluse.mdx b/docs/components/batchlistitemservertooluse.mdx index becd27892..01d83c196 100644 --- a/docs/components/batchlistitemservertooluse.mdx +++ b/docs/components/batchlistitemservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | :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. | -| `web_search_requests` | *OptionalNullable[int]* | :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 +| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | +| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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/components/batchlistitemusage.mdx b/docs/components/batchlistitemusage.mdx index 770b73573..c5748a98b 100644 --- a/docs/components/batchlistitemusage.mdx +++ b/docs/components/batchlistitemusage.mdx @@ -6,16 +6,16 @@ title: "BatchListItemUsage" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | | -| `completion_tokens_details` | [OptionalNullable[components.BatchListItemCompletionTokensDetails]](../components/batchlistitemcompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | -| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `prompt_tokens_details` | [OptionalNullable[components.BatchListItemPromptTokensDetails]](../components/batchlistitemprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `server_tool_use` | [OptionalNullable[components.BatchListItemServerToolUse]](../components/batchlistitemservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | -| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completion_tokens` | *int* | ✅ | The tokens generated | | +| `completion_tokens_details` | [OptionalNullable[components.BatchListItemCompletionTokensDetails]](../components/batchlistitemcompletiontokensdetails.mdx) | ➖ | N/A | | +| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | +| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | | +| `prompt_tokens_details` | [OptionalNullable[components.BatchListItemPromptTokensDetails]](../components/batchlistitemprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | +| `server_tool_use` | [OptionalNullable[components.BatchListItemServerToolUse]](../components/batchlistitemservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | +| `total_tokens` | *int* | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/components/batchlistresponse.mdx b/docs/components/batchlistresponse.mdx index 31a10bfb7..fcf129f43 100644 --- a/docs/components/batchlistresponse.mdx +++ b/docs/components/batchlistresponse.mdx @@ -9,8 +9,8 @@ A newest-first page of metadata-only batch objects. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | List[[components.BatchListItem](../components/batchlistitem.mdx)] | :heavy_check_mark: | N/A | -| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `has_more` | *bool* | :heavy_check_mark: | N/A | -| `last_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `object` | [components.BatchListResponseObject](../components/batchlistresponseobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.BatchListItem](../components/batchlistitem.mdx)] | ✅ | N/A | +| `first_id` | *Nullable[str]* | ✅ | N/A | +| `has_more` | *bool* | ✅ | N/A | +| `last_id` | *Nullable[str]* | ✅ | N/A | +| `object` | [components.BatchListResponseObject](../components/batchlistresponseobject.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchobject.mdx b/docs/components/batchobject.mdx index cec2c6ae6..ca69141f2 100644 --- a/docs/components/batchobject.mdx +++ b/docs/components/batchobject.mdx @@ -6,15 +6,15 @@ title: "BatchObject" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `completion_window` | [components.BatchObjectCompletionWindow](../components/batchobjectcompletionwindow.mdx) | :heavy_check_mark: | N/A | -| `created_at` | *int* | :heavy_check_mark: | N/A | -| `endpoint` | *str* | :heavy_check_mark: | N/A | -| `error` | [Nullable[components.BatchObjectError]](../components/batchobjecterror.mdx) | :heavy_check_mark: | N/A | -| `finalized_at` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `object` | [components.BatchObjectObjectBatch](../components/batchobjectobjectbatch.mdx) | :heavy_check_mark: | N/A | -| `request_counts` | [components.BatchObjectRequestCounts](../components/batchobjectrequestcounts.mdx) | :heavy_check_mark: | N/A | -| `results` | List[[components.Result](../components/result.mdx)] | :heavy_check_mark: | N/A | -| `status` | [components.BatchObjectStatus](../components/batchobjectstatus.mdx) | :heavy_check_mark: | N/A | -| `usage` | [Nullable[components.BatchObjectUsage]](../components/batchobjectusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `completion_window` | [components.BatchObjectCompletionWindow](../components/batchobjectcompletionwindow.mdx) | ✅ | N/A | +| `created_at` | *int* | ✅ | N/A | +| `endpoint` | *str* | ✅ | N/A | +| `error` | [Nullable[components.BatchObjectError]](../components/batchobjecterror.mdx) | ✅ | N/A | +| `finalized_at` | *Nullable[int]* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `model` | *str* | ✅ | N/A | +| `object` | [components.BatchObjectObjectBatch](../components/batchobjectobjectbatch.mdx) | ✅ | N/A | +| `request_counts` | [components.BatchObjectRequestCounts](../components/batchobjectrequestcounts.mdx) | ✅ | N/A | +| `results` | List[[components.Result](../components/result.mdx)] | ✅ | N/A | +| `status` | [components.BatchObjectStatus](../components/batchobjectstatus.mdx) | ✅ | N/A | +| `usage` | [Nullable[components.BatchObjectUsage]](../components/batchobjectusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectcompletiontokensdetails.mdx b/docs/components/batchobjectcompletiontokensdetails.mdx index e9374e708..77ef17c29 100644 --- a/docs/components/batchobjectcompletiontokensdetails.mdx +++ b/docs/components/batchobjectcompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchObjectCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/batchobjectdata.mdx b/docs/components/batchobjectdata.mdx index 9fab2e053..eb9bef7cf 100644 --- a/docs/components/batchobjectdata.mdx +++ b/docs/components/batchobjectdata.mdx @@ -9,6 +9,6 @@ A single embedding object | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `embedding` | [components.Embedding](../components/embedding.mdx) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the embedding in the input list | 0 | -| `object` | [components.ObjectEmbedding](../components/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `embedding` | [components.Embedding](../components/embedding.mdx) | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `index` | *Optional[int]* | ➖ | Index of the embedding in the input list | 0 | +| `object` | [components.ObjectEmbedding](../components/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/batchobjectdebug.mdx b/docs/components/batchobjectdebug.mdx index 2c534c626..8c26216a2 100644 --- a/docs/components/batchobjectdebug.mdx +++ b/docs/components/batchobjectdebug.mdx @@ -6,6 +6,6 @@ title: "BatchObjectDebug" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `echo_upstream_body` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `timings` | [Optional[components.BatchObjectTimings]](../components/batchobjecttimings.mdx) | :heavy_minus_sign: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `echo_upstream_body` | Dict[str, *Any*] | ➖ | N/A | +| `timings` | [Optional[components.BatchObjectTimings]](../components/batchobjecttimings.mdx) | ➖ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjecterror.mdx b/docs/components/batchobjecterror.mdx index ae47da322..659fc8654 100644 --- a/docs/components/batchobjecterror.mdx +++ b/docs/components/batchobjecterror.mdx @@ -6,4 +6,4 @@ title: "BatchObjectError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `message` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectfile.mdx b/docs/components/batchobjectfile.mdx index 497b24366..77854ee87 100644 --- a/docs/components/batchobjectfile.mdx +++ b/docs/components/batchobjectfile.mdx @@ -6,6 +6,6 @@ title: "BatchObjectFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `content` | List[[components.AnnotationContentUnion](../components/annotationcontentunion.mdx)] | :heavy_check_mark: | N/A | -| `hash` | *str* | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | List[[components.AnnotationContentUnion](../components/annotationcontentunion.mdx)] | ✅ | N/A | +| `hash` | *str* | ✅ | N/A | +| `name` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectfunction.mdx b/docs/components/batchobjectfunction.mdx index 0a854d990..42e373770 100644 --- a/docs/components/batchobjectfunction.mdx +++ b/docs/components/batchobjectfunction.mdx @@ -6,5 +6,5 @@ title: "BatchObjectFunction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | +| `name` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectimageurl.mdx b/docs/components/batchobjectimageurl.mdx index 70172ed5a..48acabfce 100644 --- a/docs/components/batchobjectimageurl.mdx +++ b/docs/components/batchobjectimageurl.mdx @@ -6,4 +6,4 @@ title: "BatchObjectImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectprompttokensdetails.mdx b/docs/components/batchobjectprompttokensdetails.mdx index 1bbcffd3a..975bcfdb4 100644 --- a/docs/components/batchobjectprompttokensdetails.mdx +++ b/docs/components/batchobjectprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/batchobjectrequestcounts.mdx b/docs/components/batchobjectrequestcounts.mdx index cc180f2e5..f4eb23219 100644 --- a/docs/components/batchobjectrequestcounts.mdx +++ b/docs/components/batchobjectrequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchObjectRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `completed` | *int* | :heavy_check_mark: | N/A | -| `failed` | *int* | :heavy_check_mark: | N/A | -| `total` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `completed` | *int* | ✅ | N/A | +| `failed` | *int* | ✅ | N/A | +| `total` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectresponse.mdx b/docs/components/batchobjectresponse.mdx index 2c8c03049..81e9a03a4 100644 --- a/docs/components/batchobjectresponse.mdx +++ b/docs/components/batchobjectresponse.mdx @@ -6,6 +6,6 @@ title: "BatchObjectResponse" | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `body` | [components.Body](../components/body.mdx) | :heavy_check_mark: | N/A | -| `request_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `body` | [components.Body](../components/body.mdx) | ✅ | N/A | +| `request_id` | *Nullable[str]* | ✅ | N/A | +| `status_code` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectservertooluse.mdx b/docs/components/batchobjectservertooluse.mdx index 86a211192..1e7335957 100644 --- a/docs/components/batchobjectservertooluse.mdx +++ b/docs/components/batchobjectservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | :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. | -| `web_search_requests` | *OptionalNullable[int]* | :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 +| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | +| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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/components/batchobjectservertoolusedetails.mdx b/docs/components/batchobjectservertoolusedetails.mdx index 2ba9abb72..42c5a669f 100644 --- a/docs/components/batchobjectservertoolusedetails.mdx +++ b/docs/components/batchobjectservertoolusedetails.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | :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. | -| `web_search_requests` | *OptionalNullable[int]* | :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 +| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | +| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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/components/batchobjecttimings.mdx b/docs/components/batchobjecttimings.mdx index 528b987df..06298ae2b 100644 --- a/docs/components/batchobjecttimings.mdx +++ b/docs/components/batchobjecttimings.mdx @@ -6,6 +6,6 @@ title: "BatchObjectTimings" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `epoch_ms` | *int* | :heavy_check_mark: | N/A | -| `event` | [components.BatchObjectEvent](../components/batchobjectevent.mdx) | :heavy_check_mark: | N/A | -| `start_ms` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `epoch_ms` | *int* | ✅ | N/A | +| `event` | [components.BatchObjectEvent](../components/batchobjectevent.mdx) | ✅ | N/A | +| `start_ms` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjecturlcitation.mdx b/docs/components/batchobjecturlcitation.mdx index 41036e478..1fe73084b 100644 --- a/docs/components/batchobjecturlcitation.mdx +++ b/docs/components/batchobjecturlcitation.mdx @@ -6,8 +6,8 @@ title: "BatchObjectURLCitation" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *Optional[str]* | ➖ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `title` | *str* | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchobjectusage.mdx b/docs/components/batchobjectusage.mdx index 6fc6121a1..82a90236f 100644 --- a/docs/components/batchobjectusage.mdx +++ b/docs/components/batchobjectusage.mdx @@ -6,16 +6,16 @@ title: "BatchObjectUsage" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | | -| `completion_tokens_details` | [OptionalNullable[components.BatchObjectCompletionTokensDetails]](../components/batchobjectcompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | -| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `prompt_tokens_details` | [OptionalNullable[components.BatchObjectPromptTokensDetails]](../components/batchobjectprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `server_tool_use` | [OptionalNullable[components.BatchObjectServerToolUse]](../components/batchobjectservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | -| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completion_tokens` | *int* | ✅ | The tokens generated | | +| `completion_tokens_details` | [OptionalNullable[components.BatchObjectCompletionTokensDetails]](../components/batchobjectcompletiontokensdetails.mdx) | ➖ | N/A | | +| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | +| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | | +| `prompt_tokens_details` | [OptionalNullable[components.BatchObjectPromptTokensDetails]](../components/batchobjectprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | +| `server_tool_use` | [OptionalNullable[components.BatchObjectServerToolUse]](../components/batchobjectservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | +| `total_tokens` | *int* | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx b/docs/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx index 02caac2a1..394a8cd68 100644 --- a/docs/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx +++ b/docs/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchPaymentRequiredResponseCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponseerror.mdx b/docs/components/batchpaymentrequiredresponseerror.mdx index e07f3accb..de630aaf9 100644 --- a/docs/components/batchpaymentrequiredresponseerror.mdx +++ b/docs/components/batchpaymentrequiredresponseerror.mdx @@ -6,5 +6,5 @@ title: "BatchPaymentRequiredResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponseprompttokensdetails.mdx b/docs/components/batchpaymentrequiredresponseprompttokensdetails.mdx index bc41b3015..fe6816daa 100644 --- a/docs/components/batchpaymentrequiredresponseprompttokensdetails.mdx +++ b/docs/components/batchpaymentrequiredresponseprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponserequestcounts.mdx b/docs/components/batchpaymentrequiredresponserequestcounts.mdx index 66d9b4839..6c9bad545 100644 --- a/docs/components/batchpaymentrequiredresponserequestcounts.mdx +++ b/docs/components/batchpaymentrequiredresponserequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchPaymentRequiredResponseRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `completed` | *int* | :heavy_check_mark: | N/A | -| `failed` | *int* | :heavy_check_mark: | N/A | -| `total` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `completed` | *int* | ✅ | N/A | +| `failed` | *int* | ✅ | N/A | +| `total` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/batchpaymentrequiredresponseservertooluse.mdx b/docs/components/batchpaymentrequiredresponseservertooluse.mdx index 907e46609..fbab119fc 100644 --- a/docs/components/batchpaymentrequiredresponseservertooluse.mdx +++ b/docs/components/batchpaymentrequiredresponseservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | :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. | -| `web_search_requests` | *OptionalNullable[int]* | :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 +| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | +| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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/components/batchpaymentrequiredresponseusage.mdx b/docs/components/batchpaymentrequiredresponseusage.mdx index e4b28f4d5..daf6443b7 100644 --- a/docs/components/batchpaymentrequiredresponseusage.mdx +++ b/docs/components/batchpaymentrequiredresponseusage.mdx @@ -6,16 +6,16 @@ title: "BatchPaymentRequiredResponseUsage" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | | -| `completion_tokens_details` | [OptionalNullable[components.BatchPaymentRequiredResponseCompletionTokensDetails]](../components/batchpaymentrequiredresponsecompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | -| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `prompt_tokens_details` | [OptionalNullable[components.BatchPaymentRequiredResponsePromptTokensDetails]](../components/batchpaymentrequiredresponseprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `server_tool_use` | [OptionalNullable[components.BatchPaymentRequiredResponseServerToolUse]](../components/batchpaymentrequiredresponseservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | -| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completion_tokens` | *int* | ✅ | The tokens generated | | +| `completion_tokens_details` | [OptionalNullable[components.BatchPaymentRequiredResponseCompletionTokensDetails]](../components/batchpaymentrequiredresponsecompletiontokensdetails.mdx) | ➖ | N/A | | +| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | +| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | | +| `prompt_tokens_details` | [OptionalNullable[components.BatchPaymentRequiredResponsePromptTokensDetails]](../components/batchpaymentrequiredresponseprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | +| `server_tool_use` | [OptionalNullable[components.BatchPaymentRequiredResponseServerToolUse]](../components/batchpaymentrequiredresponseservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | +| `total_tokens` | *int* | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/components/batchproviderpreferences.mdx b/docs/components/batchproviderpreferences.mdx index f3a21d140..d7ba53e63 100644 --- a/docs/components/batchproviderpreferences.mdx +++ b/docs/components/batchproviderpreferences.mdx @@ -9,5 +9,5 @@ Batch provider routing preferences. Only `provider.only` and `provider.allow_fal | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allow_fallbacks` | *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` | List[[components.BatchProviderPreferencesOnly](../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 +| `allow_fallbacks` | *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` | List[[components.BatchProviderPreferencesOnly](../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/components/batchsubmitbody.mdx b/docs/components/batchsubmitbody.mdx index 5f85713cf..f6af1fb5b 100644 --- a/docs/components/batchsubmitbody.mdx +++ b/docs/components/batchsubmitbody.mdx @@ -9,8 +9,8 @@ Batch submit request body. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `completion_window` | [Optional[components.BatchSubmitBodyCompletionWindow]](../components/batchsubmitbodycompletionwindow.mdx) | :heavy_minus_sign: | N/A | | -| `endpoint` | [components.Endpoint](../components/endpoint.mdx) | :heavy_check_mark: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `provider` | [OptionalNullable[components.BatchProviderPreferences]](../components/batchproviderpreferences.mdx) | :heavy_minus_sign: | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | -| `requests` | List[[components.Request](../components/request.mdx)] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `completion_window` | [Optional[components.BatchSubmitBodyCompletionWindow]](../components/batchsubmitbodycompletionwindow.mdx) | ➖ | N/A | | +| `endpoint` | [components.Endpoint](../components/endpoint.mdx) | ✅ | N/A | | +| `model` | *str* | ✅ | N/A | | +| `provider` | [OptionalNullable[components.BatchProviderPreferences]](../components/batchproviderpreferences.mdx) | ➖ | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | +| `requests` | List[[components.Request](../components/request.mdx)] | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/bodychatcompletion.mdx b/docs/components/bodychatcompletion.mdx index 268627065..ff3bd7cad 100644 --- a/docs/components/bodychatcompletion.mdx +++ b/docs/components/bodychatcompletion.mdx @@ -6,15 +6,15 @@ title: "BodyChatCompletion" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alignment` | [Optional[components.Alignment]](../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` | List[[components.Choice](../components/choice.mdx)] | :heavy_check_mark: | N/A | | -| `created` | *int* | :heavy_check_mark: | N/A | | -| `debug` | [Optional[components.BatchObjectDebug]](../components/batchobjectdebug.mdx) | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `object` | [components.BodyObjectChatCompletion](../components/bodyobjectchatcompletion.mdx) | :heavy_check_mark: | N/A | | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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[str]* | :heavy_minus_sign: | N/A | | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `usage` | [Optional[components.BodyUsage1]](../components/bodyusage1.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `alignment` | [Optional[components.Alignment]](../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` | List[[components.Choice](../components/choice.mdx)] | ✅ | N/A | | +| `created` | *int* | ✅ | N/A | | +| `debug` | [Optional[components.BatchObjectDebug]](../components/batchobjectdebug.mdx) | ➖ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `model` | *str* | ✅ | N/A | | +| `object` | [components.BodyObjectChatCompletion](../components/bodyobjectchatcompletion.mdx) | ✅ | N/A | | +| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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[str]* | ➖ | N/A | | +| `service_tier` | *OptionalNullable[str]* | ➖ | N/A | | +| `system_fingerprint` | *OptionalNullable[str]* | ➖ | N/A | | +| `usage` | [Optional[components.BodyUsage1]](../components/bodyusage1.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/bodycompletiontokensdetails.mdx b/docs/components/bodycompletiontokensdetails.mdx index 903c963ca..69b8630eb 100644 --- a/docs/components/bodycompletiontokensdetails.mdx +++ b/docs/components/bodycompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BodyCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/bodylist.mdx b/docs/components/bodylist.mdx index 2cd0a5e7b..f5a5048ac 100644 --- a/docs/components/bodylist.mdx +++ b/docs/components/bodylist.mdx @@ -9,8 +9,8 @@ Embeddings response containing embedding vectors | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | List[[components.BatchObjectData](../components/batchobjectdata.mdx)] | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | -| `model` | *str* | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | -| `object` | [components.BodyObjectList](../components/bodyobjectlist.mdx) | :heavy_check_mark: | N/A | | -| `usage` | [Optional[components.BodyUsage3]](../components/bodyusage3.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `data` | List[[components.BatchObjectData](../components/batchobjectdata.mdx)] | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `id` | *Optional[str]* | ➖ | Unique identifier for the embeddings response | embd-1234567890 | +| `model` | *str* | ✅ | The model used for embeddings | openai/text-embedding-3-small | +| `object` | [components.BodyObjectList](../components/bodyobjectlist.mdx) | ✅ | N/A | | +| `usage` | [Optional[components.BodyUsage3]](../components/bodyusage3.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file diff --git a/docs/components/bodymessage.mdx b/docs/components/bodymessage.mdx index 92a8aa873..785e9f2c3 100644 --- a/docs/components/bodymessage.mdx +++ b/docs/components/bodymessage.mdx @@ -6,14 +6,14 @@ title: "BodyMessage" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container` | [Nullable[components.AnthropicContainer]](../components/anthropiccontainer.mdx) | :heavy_check_mark: | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | -| `content` | List[[components.ORAnthropicContentBlock](../components/oranthropiccontentblock.mdx)] | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `input_transformations` | List[[components.AnthropicInputTransformation](../components/anthropicinputtransformation.mdx)] | :heavy_minus_sign: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `role` | [components.BatchObjectRole](../components/batchobjectrole.mdx) | :heavy_check_mark: | N/A | | -| `stop_details` | [Nullable[components.AnthropicRefusalStopDetails]](../components/anthropicrefusalstopdetails.mdx) | :heavy_check_mark: | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | -| `stop_reason` | [Nullable[components.ORAnthropicStopReason]](../components/oranthropicstopreason.mdx) | :heavy_check_mark: | N/A | end_turn | -| `stop_sequence` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `type` | [components.BatchObjectTypeMessage](../components/batchobjecttypemessage.mdx) | :heavy_check_mark: | N/A | | -| `usage` | [components.BodyUsage2](../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` | [Nullable[components.AnthropicContainer]](../components/anthropiccontainer.mdx) | ✅ | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | +| `content` | List[[components.ORAnthropicContentBlock](../components/oranthropiccontentblock.mdx)] | ✅ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `input_transformations` | List[[components.AnthropicInputTransformation](../components/anthropicinputtransformation.mdx)] | ➖ | N/A | | +| `model` | *str* | ✅ | N/A | | +| `role` | [components.BatchObjectRole](../components/batchobjectrole.mdx) | ✅ | N/A | | +| `stop_details` | [Nullable[components.AnthropicRefusalStopDetails]](../components/anthropicrefusalstopdetails.mdx) | ✅ | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | +| `stop_reason` | [Nullable[components.ORAnthropicStopReason]](../components/oranthropicstopreason.mdx) | ✅ | N/A | end_turn | +| `stop_sequence` | *Nullable[str]* | ✅ | N/A | | +| `type` | [components.BatchObjectTypeMessage](../components/batchobjecttypemessage.mdx) | ✅ | N/A | | +| `usage` | [components.BodyUsage2](../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/components/bodyprompttokensdetails1.mdx b/docs/components/bodyprompttokensdetails1.mdx index 29c622415..1de48e3da 100644 --- a/docs/components/bodyprompttokensdetails1.mdx +++ b/docs/components/bodyprompttokensdetails1.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/bodyprompttokensdetails2.mdx b/docs/components/bodyprompttokensdetails2.mdx index 6462670ef..2f6072187 100644 --- a/docs/components/bodyprompttokensdetails2.mdx +++ b/docs/components/bodyprompttokensdetails2.mdx @@ -9,8 +9,8 @@ Per-modality token breakdown. Only present when the input contains 2+ modalities | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `audio_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of audio tokens in the input | | -| `file_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of file/document tokens in the input | | -| `image_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of image tokens in the input | 258 | -| `text_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of text tokens in the input | 8 | -| `video_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file +| `audio_tokens` | *Optional[int]* | ➖ | Number of audio tokens in the input | | +| `file_tokens` | *Optional[int]* | ➖ | Number of file/document tokens in the input | | +| `image_tokens` | *Optional[int]* | ➖ | Number of image tokens in the input | 258 | +| `text_tokens` | *Optional[int]* | ➖ | Number of text tokens in the input | 8 | +| `video_tokens` | *Optional[int]* | ➖ | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/components/bodyservertooluse.mdx b/docs/components/bodyservertooluse.mdx index 3e20a38a7..39af647bf 100644 --- a/docs/components/bodyservertooluse.mdx +++ b/docs/components/bodyservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | :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. | -| `web_search_requests` | *OptionalNullable[int]* | :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 +| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | +| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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/components/bodyusage1.mdx b/docs/components/bodyusage1.mdx index 61f933e34..4161bf32e 100644 --- a/docs/components/bodyusage1.mdx +++ b/docs/components/bodyusage1.mdx @@ -6,10 +6,10 @@ title: "BodyUsage1" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | -| `completion_tokens_details` | [OptionalNullable[components.BodyCompletionTokensDetails]](../components/bodycompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | -| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | -| `prompt_tokens_details` | [OptionalNullable[components.BodyPromptTokensDetails1]](../components/bodyprompttokensdetails1.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | -| `server_tool_use` | [OptionalNullable[components.BodyServerToolUse]](../components/bodyservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | -| `server_tool_use_details` | [OptionalNullable[components.BatchObjectServerToolUseDetails]](../components/batchobjectservertoolusedetails.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | -| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | \ No newline at end of file +| `completion_tokens` | *int* | ✅ | The tokens generated | +| `completion_tokens_details` | [OptionalNullable[components.BodyCompletionTokensDetails]](../components/bodycompletiontokensdetails.mdx) | ➖ | N/A | +| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | +| `prompt_tokens_details` | [OptionalNullable[components.BodyPromptTokensDetails1]](../components/bodyprompttokensdetails1.mdx) | ➖ | Breakdown of tokens used in the prompt. | +| `server_tool_use` | [OptionalNullable[components.BodyServerToolUse]](../components/bodyservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | +| `server_tool_use_details` | [OptionalNullable[components.BatchObjectServerToolUseDetails]](../components/batchobjectservertoolusedetails.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | +| `total_tokens` | *int* | ✅ | Sum of the above two fields | \ No newline at end of file diff --git a/docs/components/bodyusage2.mdx b/docs/components/bodyusage2.mdx index 56c99f9b1..c57f51128 100644 --- a/docs/components/bodyusage2.mdx +++ b/docs/components/bodyusage2.mdx @@ -6,14 +6,14 @@ title: "BodyUsage2" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `cache_creation` | [Nullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_check_mark: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `cache_creation_input_tokens` | *Nullable[int]* | :heavy_check_mark: | N/A | | -| `cache_read_input_tokens` | *Nullable[int]* | :heavy_check_mark: | N/A | | -| `inference_geo` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `input_tokens` | *int* | :heavy_check_mark: | N/A | | -| `output_tokens` | *int* | :heavy_check_mark: | N/A | | -| `output_tokens_details` | [Nullable[components.AnthropicOutputTokensDetails]](../components/anthropicoutputtokensdetails.mdx) | :heavy_check_mark: | N/A | \{
"thinking_tokens": 0
} | -| `server_tool_use` | [Nullable[components.AnthropicServerToolUsage]](../components/anthropicservertoolusage.mdx) | :heavy_check_mark: | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | -| `service_tier` | [Nullable[components.AnthropicServiceTier]](../components/anthropicservicetier.mdx) | :heavy_check_mark: | N/A | standard | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | \ No newline at end of file +| `cache_creation` | [Nullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ✅ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `cache_creation_input_tokens` | *Nullable[int]* | ✅ | N/A | | +| `cache_read_input_tokens` | *Nullable[int]* | ✅ | N/A | | +| `inference_geo` | *Nullable[str]* | ✅ | N/A | | +| `input_tokens` | *int* | ✅ | N/A | | +| `output_tokens` | *int* | ✅ | N/A | | +| `output_tokens_details` | [Nullable[components.AnthropicOutputTokensDetails]](../components/anthropicoutputtokensdetails.mdx) | ✅ | N/A | \{
"thinking_tokens": 0
} | +| `server_tool_use` | [Nullable[components.AnthropicServerToolUsage]](../components/anthropicservertoolusage.mdx) | ✅ | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | +| `service_tier` | [Nullable[components.AnthropicServiceTier]](../components/anthropicservicetier.mdx) | ✅ | N/A | standard | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | \ No newline at end of file diff --git a/docs/components/bodyusage3.mdx b/docs/components/bodyusage3.mdx index 9de6b2bf6..5101a5733 100644 --- a/docs/components/bodyusage3.mdx +++ b/docs/components/bodyusage3.mdx @@ -9,9 +9,9 @@ Token usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cost` | *Optional[float]* | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `prompt_tokens` | *int* | :heavy_check_mark: | Number of tokens in the input | 8 | -| `prompt_tokens_details` | [Optional[components.BodyPromptTokensDetails2]](../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. | | -| `total_tokens` | *int* | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file +| `cost` | *Optional[float]* | ➖ | Cost of the request in credits | 0.0001 | +| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `prompt_tokens` | *int* | ✅ | Number of tokens in the input | 8 | +| `prompt_tokens_details` | [Optional[components.BodyPromptTokensDetails2]](../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. | | +| `total_tokens` | *int* | ✅ | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/components/booleancapability.mdx b/docs/components/booleancapability.mdx index 74ba07281..28e674242 100644 --- a/docs/components/booleancapability.mdx +++ b/docs/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](../components/booleancapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.BooleanCapabilityType](../components/booleancapabilitytype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/bulkaddworkspacemembersrequest.mdx b/docs/components/bulkaddworkspacemembersrequest.mdx index 677367875..86cd8f022 100644 --- a/docs/components/bulkaddworkspacemembersrequest.mdx +++ b/docs/components/bulkaddworkspacemembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAddWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `user_ids` | List[*str*] | :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 +| `user_ids` | List[*str*] | ✅ | 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/components/bulkaddworkspacemembersresponse.mdx b/docs/components/bulkaddworkspacemembersresponse.mdx index 4550429c5..4082d6f62 100644 --- a/docs/components/bulkaddworkspacemembersresponse.mdx +++ b/docs/components/bulkaddworkspacemembersresponse.mdx @@ -6,5 +6,5 @@ title: "BulkAddWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `added_count` | *int* | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | -| `data` | List[[components.WorkspaceMember](../components/workspacemember.mdx)] | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file +| `added_count` | *int* | ✅ | Number of workspace memberships created or updated | 2 | +| `data` | List[[components.WorkspaceMember](../components/workspacemember.mdx)] | ✅ | List of added workspace memberships | | \ No newline at end of file diff --git a/docs/components/bulkassignkeysrequest.mdx b/docs/components/bulkassignkeysrequest.mdx index ce5a37d8d..94ba7f253 100644 --- a/docs/components/bulkassignkeysrequest.mdx +++ b/docs/components/bulkassignkeysrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAssignKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `key_hashes` | List[*str*] | ✅ | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/components/bulkassignkeysresponse.mdx b/docs/components/bulkassignkeysresponse.mdx index a9f54e53b..b37655b1d 100644 --- a/docs/components/bulkassignkeysresponse.mdx +++ b/docs/components/bulkassignkeysresponse.mdx @@ -6,4 +6,4 @@ title: "BulkAssignKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `assigned_count` | *int* | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file +| `assigned_count` | *int* | ✅ | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/docs/components/bulkassignmembersrequest.mdx b/docs/components/bulkassignmembersrequest.mdx index 272a74b2a..a84aa25d3 100644 --- a/docs/components/bulkassignmembersrequest.mdx +++ b/docs/components/bulkassignmembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAssignMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `member_user_ids` | List[*str*] | ✅ | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/components/bulkassignmembersresponse.mdx b/docs/components/bulkassignmembersresponse.mdx index fb4f9e2b8..b388dde21 100644 --- a/docs/components/bulkassignmembersresponse.mdx +++ b/docs/components/bulkassignmembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkAssignMembersResponse" | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `assigned_count` | *int* | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file +| `assigned_count` | *int* | ✅ | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/docs/components/bulkremoveworkspacemembersrequest.mdx b/docs/components/bulkremoveworkspacemembersrequest.mdx index e05a95672..f016018a8 100644 --- a/docs/components/bulkremoveworkspacemembersrequest.mdx +++ b/docs/components/bulkremoveworkspacemembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkRemoveWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `user_ids` | List[*str*] | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `user_ids` | List[*str*] | ✅ | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/components/bulkremoveworkspacemembersresponse.mdx b/docs/components/bulkremoveworkspacemembersresponse.mdx index a4537109a..3cb793681 100644 --- a/docs/components/bulkremoveworkspacemembersresponse.mdx +++ b/docs/components/bulkremoveworkspacemembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkRemoveWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `removed_count` | *int* | :heavy_check_mark: | Number of members removed | 2 | \ No newline at end of file +| `removed_count` | *int* | ✅ | Number of members removed | 2 | \ No newline at end of file diff --git a/docs/components/bulkunassignkeysrequest.mdx b/docs/components/bulkunassignkeysrequest.mdx index 53506dd9c..e4196d4e4 100644 --- a/docs/components/bulkunassignkeysrequest.mdx +++ b/docs/components/bulkunassignkeysrequest.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `key_hashes` | List[*str*] | ✅ | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/components/bulkunassignkeysresponse.mdx b/docs/components/bulkunassignkeysresponse.mdx index efa2bc14b..146bba3ae 100644 --- a/docs/components/bulkunassignkeysresponse.mdx +++ b/docs/components/bulkunassignkeysresponse.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignKeysResponse" | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `unassigned_count` | *int* | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file +| `unassigned_count` | *int* | ✅ | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/docs/components/bulkunassignmembersrequest.mdx b/docs/components/bulkunassignmembersrequest.mdx index a39b1c218..a71c4af19 100644 --- a/docs/components/bulkunassignmembersrequest.mdx +++ b/docs/components/bulkunassignmembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `member_user_ids` | List[*str*] | ✅ | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/components/bulkunassignmembersresponse.mdx b/docs/components/bulkunassignmembersresponse.mdx index 1907c8262..23c14efc5 100644 --- a/docs/components/bulkunassignmembersresponse.mdx +++ b/docs/components/bulkunassignmembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignMembersResponse" | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `unassigned_count` | *int* | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file +| `unassigned_count` | *int* | ✅ | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/docs/components/byokkey.mdx b/docs/components/byokkey.mdx index e68d9db48..aa1d7a042 100644 --- a/docs/components/byokkey.mdx +++ b/docs/components/byokkey.mdx @@ -6,19 +6,19 @@ title: "BYOKKey" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `allowed_models` | List[*str*] | :heavy_check_mark: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | :heavy_check_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `created_at` | *str* | :heavy_check_mark: | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | -| `declared_region` | [Nullable[components.BYOKKeyDeclaredRegion]](../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 | -| `declared_zdr` | *Nullable[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` | *str* | :heavy_check_mark: | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | -| `is_byok_only` | *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 | -| `is_fallback` | *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 | -| `is_required` | *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` | *str* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [components.BYOKProviderSlug](../components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `sort_order` | *int* | :heavy_check_mark: | Position within the provider — credentials are tried in ascending sort order. | 0 | -| `workspace_id` | *Nullable[str]* | :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 +| `allowed_api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `allowed_models` | List[*str*] | ✅ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | ✅ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `created_at` | *str* | ✅ | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | +| `declared_region` | [Nullable[components.BYOKKeyDeclaredRegion]](../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 | +| `declared_zdr` | *Nullable[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` | *str* | ✅ | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | +| `is_byok_only` | *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 | +| `is_fallback` | *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 | +| `is_required` | *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` | *str* | ✅ | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | +| `name` | *OptionalNullable[str]* | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | +| `provider` | [components.BYOKProviderSlug](../components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `sort_order` | *int* | ✅ | Position within the provider — credentials are tried in ascending sort order. | 0 | +| `workspace_id` | *Nullable[str]* | ✅ | 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/components/chatassistantimages.mdx b/docs/components/chatassistantimages.mdx index fbd1a4de8..5fa709791 100644 --- a/docs/components/chatassistantimages.mdx +++ b/docs/components/chatassistantimages.mdx @@ -6,4 +6,4 @@ title: "ChatAssistantImages" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `image_url` | [components.ChatAssistantImagesImageURL](../components/chatassistantimagesimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `image_url` | [components.ChatAssistantImagesImageURL](../components/chatassistantimagesimageurl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chatassistantimagesimageurl.mdx b/docs/components/chatassistantimagesimageurl.mdx index 8a36279a1..ddcf19f7d 100644 --- a/docs/components/chatassistantimagesimageurl.mdx +++ b/docs/components/chatassistantimagesimageurl.mdx @@ -6,4 +6,4 @@ title: "ChatAssistantImagesImageURL" | Field | Type | Required | Description | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `url` | *str* | :heavy_check_mark: | URL or base64-encoded data of the generated image | \ No newline at end of file +| `url` | *str* | ✅ | URL or base64-encoded data of the generated image | \ No newline at end of file diff --git a/docs/components/chatassistantmessage.mdx b/docs/components/chatassistantmessage.mdx index bcd7ebd8c..747e8b15b 100644 --- a/docs/components/chatassistantmessage.mdx +++ b/docs/components/chatassistantmessage.mdx @@ -9,13 +9,13 @@ Assistant message for requests and responses | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [Optional[components.ChatAudioOutput]](../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[components.ChatAssistantMessageContent]](../components/chatassistantmessagecontent.mdx) | :heavy_minus_sign: | Assistant message content | | -| `images` | List[[components.ChatAssistantImages](../components/chatassistantimages.mdx)] | :heavy_minus_sign: | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | Model that generated this assistant message | openai/gpt-4o | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the assistant | | -| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning output | | -| `reasoning_details` | List[[components.ReasoningDetailUnion](../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[str]* | :heavy_minus_sign: | Refusal message if content was refused | | -| `role` | [components.ChatAssistantMessageRole](../components/chatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `tool_calls` | List[[components.ChatToolCall](../components/chattoolcall.mdx)] | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file +| `audio` | [Optional[components.ChatAudioOutput]](../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[components.ChatAssistantMessageContent]](../components/chatassistantmessagecontent.mdx) | ➖ | Assistant message content | | +| `images` | List[[components.ChatAssistantImages](../components/chatassistantimages.mdx)] | ➖ | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | +| `model` | *Optional[str]* | ➖ | Model that generated this assistant message | openai/gpt-4o | +| `name` | *Optional[str]* | ➖ | Optional name for the assistant | | +| `reasoning` | *OptionalNullable[str]* | ➖ | Reasoning output | | +| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.mdx)] | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | +| `refusal` | *OptionalNullable[str]* | ➖ | Refusal message if content was refused | | +| `role` | [components.ChatAssistantMessageRole](../components/chatassistantmessagerole.mdx) | ✅ | N/A | | +| `tool_calls` | List[[components.ChatToolCall](../components/chattoolcall.mdx)] | ➖ | Tool calls made by the assistant | | \ No newline at end of file diff --git a/docs/components/chataudiooutput.mdx b/docs/components/chataudiooutput.mdx index 54812b591..a1767a9c2 100644 --- a/docs/components/chataudiooutput.mdx +++ b/docs/components/chataudiooutput.mdx @@ -9,7 +9,7 @@ Audio output data or reference | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `data` | *Optional[str]* | :heavy_minus_sign: | Base64 encoded audio data | -| `expires_at` | *Optional[int]* | :heavy_minus_sign: | Audio expiration timestamp | -| `id` | *Optional[str]* | :heavy_minus_sign: | Audio output identifier | -| `transcript` | *Optional[str]* | :heavy_minus_sign: | Audio transcript | \ No newline at end of file +| `data` | *Optional[str]* | ➖ | Base64 encoded audio data | +| `expires_at` | *Optional[int]* | ➖ | Audio expiration timestamp | +| `id` | *Optional[str]* | ➖ | Audio output identifier | +| `transcript` | *Optional[str]* | ➖ | Audio transcript | \ No newline at end of file diff --git a/docs/components/chatchoice.mdx b/docs/components/chatchoice.mdx index 614393130..e40691404 100644 --- a/docs/components/chatchoice.mdx +++ b/docs/components/chatchoice.mdx @@ -9,7 +9,7 @@ Chat completion choice | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | -| `index` | *int* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../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](../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 +| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.mdx) | ✅ | N/A | stop | +| `index` | *int* | ✅ | Choice index | 0 | +| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../components/chattokenlogprobs.mdx) | ➖ | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | +| `message` | [components.ChatAssistantMessage](../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/components/chatcontentaudio.mdx b/docs/components/chatcontentaudio.mdx index 4fded9376..11f0829a5 100644 --- a/docs/components/chatcontentaudio.mdx +++ b/docs/components/chatcontentaudio.mdx @@ -9,5 +9,5 @@ Audio input content part. Supported audio formats vary by provider. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `input_audio` | [components.ChatContentAudioInputAudio](../components/chatcontentaudioinputaudio.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.ChatContentAudioType](../components/chatcontentaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `input_audio` | [components.ChatContentAudioInputAudio](../components/chatcontentaudioinputaudio.mdx) | ✅ | N/A | +| `type` | [components.ChatContentAudioType](../components/chatcontentaudiotype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chatcontentaudioinputaudio.mdx b/docs/components/chatcontentaudioinputaudio.mdx index 06fd6a6c7..334c09222 100644 --- a/docs/components/chatcontentaudioinputaudio.mdx +++ b/docs/components/chatcontentaudioinputaudio.mdx @@ -6,5 +6,5 @@ title: "ChatContentAudioInputAudio" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | Base64 encoded audio data | -| `format_` | *str* | :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` | *str* | ✅ | Base64 encoded audio data | +| `format_` | *str* | ✅ | 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/components/chatcontentcachecontrol.mdx b/docs/components/chatcontentcachecontrol.mdx index 6f1d2f8e0..5ea044a53 100644 --- a/docs/components/chatcontentcachecontrol.mdx +++ b/docs/components/chatcontentcachecontrol.mdx @@ -9,5 +9,5 @@ Anthropic-style cache breakpoint for the content part. Interchangeable with the | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `type` | [components.ChatContentCacheControlType](../components/chatcontentcachecontroltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | +| `type` | [components.ChatContentCacheControlType](../components/chatcontentcachecontroltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/chatcontentfile.mdx b/docs/components/chatcontentfile.mdx index 6be5dcf78..bb3770602 100644 --- a/docs/components/chatcontentfile.mdx +++ b/docs/components/chatcontentfile.mdx @@ -9,5 +9,5 @@ File content part for document processing | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `file` | [components.ChatContentFileFile](../components/chatcontentfilefile.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.ChatContentFileType](../components/chatcontentfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file` | [components.ChatContentFileFile](../components/chatcontentfilefile.mdx) | ✅ | N/A | +| `type` | [components.ChatContentFileType](../components/chatcontentfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chatcontentfilefile.mdx b/docs/components/chatcontentfilefile.mdx index 8db78d18e..cd1e9fac3 100644 --- a/docs/components/chatcontentfilefile.mdx +++ b/docs/components/chatcontentfilefile.mdx @@ -6,6 +6,6 @@ title: "ChatContentFileFile" | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `file_data` | *Optional[str]* | :heavy_minus_sign: | File content as base64 data URL or URL | -| `file_id` | *Optional[str]* | :heavy_minus_sign: | File ID for previously uploaded files | -| `filename` | *Optional[str]* | :heavy_minus_sign: | Original filename | \ No newline at end of file +| `file_data` | *Optional[str]* | ➖ | File content as base64 data URL or URL | +| `file_id` | *Optional[str]* | ➖ | File ID for previously uploaded files | +| `filename` | *Optional[str]* | ➖ | Original filename | \ No newline at end of file diff --git a/docs/components/chatcontentimage.mdx b/docs/components/chatcontentimage.mdx index 1dc215991..1d3fe4002 100644 --- a/docs/components/chatcontentimage.mdx +++ b/docs/components/chatcontentimage.mdx @@ -9,5 +9,5 @@ Image content part for vision models | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `image_url` | [components.ChatContentImageImageURL](../components/chatcontentimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.ChatContentImageType](../components/chatcontentimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `image_url` | [components.ChatContentImageImageURL](../components/chatcontentimageimageurl.mdx) | ✅ | N/A | +| `type` | [components.ChatContentImageType](../components/chatcontentimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chatcontentimageimageurl.mdx b/docs/components/chatcontentimageimageurl.mdx index 814136649..3a95d06de 100644 --- a/docs/components/chatcontentimageimageurl.mdx +++ b/docs/components/chatcontentimageimageurl.mdx @@ -6,5 +6,5 @@ title: "ChatContentImageImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `detail` | [Optional[components.ChatContentImageDetail]](../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` | *str* | :heavy_check_mark: | URL of the image (data: URLs supported) | \ No newline at end of file +| `detail` | [Optional[components.ChatContentImageDetail]](../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` | *str* | ✅ | URL of the image (data: URLs supported) | \ No newline at end of file diff --git a/docs/components/chatcontenttext.mdx b/docs/components/chatcontenttext.mdx index b31006bd9..9c1f10de5 100644 --- a/docs/components/chatcontenttext.mdx +++ b/docs/components/chatcontenttext.mdx @@ -9,7 +9,7 @@ Text content part | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.ChatContentCacheControl]](../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"
} | -| `prompt_cache_breakpoint` | [OptionalNullable[components.PromptCacheBreakpoint]](../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` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.ChatContentTextType](../components/chatcontenttexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.ChatContentCacheControl]](../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"
} | +| `prompt_cache_breakpoint` | [OptionalNullable[components.PromptCacheBreakpoint]](../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` | *str* | ✅ | N/A | | +| `type` | [components.ChatContentTextType](../components/chatcontenttexttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/chatcontentvideo.mdx b/docs/components/chatcontentvideo.mdx index b8a1d5ee3..2af782102 100644 --- a/docs/components/chatcontentvideo.mdx +++ b/docs/components/chatcontentvideo.mdx @@ -9,5 +9,5 @@ Video input content part | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [components.ChatContentVideoType](../components/chatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | -| `video_url` | [components.ChatContentVideoInput](../components/chatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `type` | [components.ChatContentVideoType](../components/chatcontentvideotype.mdx) | ✅ | N/A | | +| `video_url` | [components.ChatContentVideoInput](../components/chatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/components/chatcontentvideoinput.mdx b/docs/components/chatcontentvideoinput.mdx index 3e3d6273f..4bcc511df 100644 --- a/docs/components/chatcontentvideoinput.mdx +++ b/docs/components/chatcontentvideoinput.mdx @@ -9,5 +9,5 @@ Video input object | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `processing` | [Optional[components.ChatContentVideoInputProcessing]](../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` | *str* | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file +| `processing` | [Optional[components.ChatContentVideoInputProcessing]](../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` | *str* | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/components/chatdebugoptions.mdx b/docs/components/chatdebugoptions.mdx index eee9489fd..1d8c85bac 100644 --- a/docs/components/chatdebugoptions.mdx +++ b/docs/components/chatdebugoptions.mdx @@ -9,4 +9,4 @@ Debug options for inspecting request transformations (streaming only) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `echo_upstream_body` | *Optional[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 +| `echo_upstream_body` | *Optional[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/components/chatdevelopermessage.mdx b/docs/components/chatdevelopermessage.mdx index 3db8a03b3..9dff56a52 100644 --- a/docs/components/chatdevelopermessage.mdx +++ b/docs/components/chatdevelopermessage.mdx @@ -9,7 +9,7 @@ Developer message | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration_update` | [OptionalNullable[components.ChatDeveloperMessageConfigurationUpdate]](../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](../components/chatdevelopermessagecontent.mdx) | :heavy_check_mark: | Developer message content | This is a message from the developer. | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the developer message | Developer | -| `role` | [components.ChatDeveloperMessageRole](../components/chatdevelopermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `configuration_update` | [OptionalNullable[components.ChatDeveloperMessageConfigurationUpdate]](../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](../components/chatdevelopermessagecontent.mdx) | ✅ | Developer message content | This is a message from the developer. | +| `name` | *Optional[str]* | ➖ | Optional name for the developer message | Developer | +| `role` | [components.ChatDeveloperMessageRole](../components/chatdevelopermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/chatdevelopermessageconfigurationupdate.mdx b/docs/components/chatdevelopermessageconfigurationupdate.mdx index f4dfd91b7..0681a6eac 100644 --- a/docs/components/chatdevelopermessageconfigurationupdate.mdx +++ b/docs/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](../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](../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/components/chatdynamicservertool.mdx b/docs/components/chatdynamicservertool.mdx index 052db3b05..a8a1e9a98 100644 --- a/docs/components/chatdynamicservertool.mdx +++ b/docs/components/chatdynamicservertool.mdx @@ -9,5 +9,5 @@ Generic OpenRouter server-tool envelope. `type` names a registered server tool ( | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `type` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `parameters` | Dict[str, *Any*] | ➖ | N/A | +| `type` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chatformatgrammarconfig.mdx b/docs/components/chatformatgrammarconfig.mdx index 8595b8642..35db774b9 100644 --- a/docs/components/chatformatgrammarconfig.mdx +++ b/docs/components/chatformatgrammarconfig.mdx @@ -9,5 +9,5 @@ Custom grammar response format | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `grammar` | *str* | :heavy_check_mark: | Custom grammar for text generation | root ::= "yes" \| "no" | -| `type` | [components.ChatFormatGrammarConfigType](../components/chatformatgrammarconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `grammar` | *str* | ✅ | Custom grammar for text generation | root ::= "yes" \| "no" | +| `type` | [components.ChatFormatGrammarConfigType](../components/chatformatgrammarconfigtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/chatformatjsonobjectconfig.mdx b/docs/components/chatformatjsonobjectconfig.mdx index 5dae96c73..f7051d078 100644 --- a/docs/components/chatformatjsonobjectconfig.mdx +++ b/docs/components/chatformatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | [components.ChatFormatJSONObjectConfigType](../components/chatformatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.ChatFormatJSONObjectConfigType](../components/chatformatjsonobjectconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chatformatjsonschemaconfig.mdx b/docs/components/chatformatjsonschemaconfig.mdx index 565e33485..33f6fc167 100644 --- a/docs/components/chatformatjsonschemaconfig.mdx +++ b/docs/components/chatformatjsonschemaconfig.mdx @@ -9,5 +9,5 @@ JSON Schema response format for structured outputs | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `json_schema` | [components.ChatJSONSchemaConfig](../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](../components/chatformatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `json_schema` | [components.ChatJSONSchemaConfig](../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](../components/chatformatjsonschemaconfigtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/chatformatpythonconfig.mdx b/docs/components/chatformatpythonconfig.mdx index cd0ab7ba1..b8d26c41c 100644 --- a/docs/components/chatformatpythonconfig.mdx +++ b/docs/components/chatformatpythonconfig.mdx @@ -9,4 +9,4 @@ Python code response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.ChatFormatPythonConfigType](../components/chatformatpythonconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.ChatFormatPythonConfigType](../components/chatformatpythonconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chatformattextconfig.mdx b/docs/components/chatformattextconfig.mdx index a539cad56..188e66488 100644 --- a/docs/components/chatformattextconfig.mdx +++ b/docs/components/chatformattextconfig.mdx @@ -9,4 +9,4 @@ Default text response format | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.ChatFormatTextConfigType](../components/chatformattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.ChatFormatTextConfigType](../components/chatformattextconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chatfunctiontoolfunction.mdx b/docs/components/chatfunctiontoolfunction.mdx index 0d3267343..bc7e937dd 100644 --- a/docs/components/chatfunctiontoolfunction.mdx +++ b/docs/components/chatfunctiontoolfunction.mdx @@ -6,7 +6,7 @@ title: "ChatFunctionToolFunction" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.ChatContentCacheControl]](../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"
} | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `function` | [components.ChatFunctionToolFunctionFunction](../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](../components/chatfunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.ChatContentCacheControl]](../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"
} | +| `defer_loading` | *Optional[bool]* | ➖ | N/A | | +| `function` | [components.ChatFunctionToolFunctionFunction](../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](../components/chatfunctiontooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/chatfunctiontoolfunctionfunction.mdx b/docs/components/chatfunctiontoolfunctionfunction.mdx index b94555ae2..adecc6e87 100644 --- a/docs/components/chatfunctiontoolfunctionfunction.mdx +++ b/docs/components/chatfunctiontoolfunctionfunction.mdx @@ -9,8 +9,8 @@ Function definition for tool calling | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `description` | *Optional[str]* | :heavy_minus_sign: | Function description for the model | Get the current weather for a location | -| `name` | *str* | :heavy_check_mark: | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | -| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file +| `defer_loading` | *Optional[bool]* | ➖ | N/A | | +| `description` | *Optional[str]* | ➖ | Function description for the model | Get the current weather for a location | +| `name` | *str* | ✅ | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | +| `parameters` | Dict[str, *Any*] | ➖ | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | +| `strict` | *OptionalNullable[bool]* | ➖ | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/components/chatjsonschemaconfig.mdx b/docs/components/chatjsonschemaconfig.mdx index 08887f520..6cdf9d887 100644 --- a/docs/components/chatjsonschemaconfig.mdx +++ b/docs/components/chatjsonschemaconfig.mdx @@ -9,7 +9,7 @@ JSON Schema configuration object | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `description` | *Optional[str]* | :heavy_minus_sign: | Schema description for the model | A mathematical response | -| `name` | *str* | :heavy_check_mark: | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | -| `schema_` | Dict[str, *Any*] | :heavy_minus_sign: | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file +| `description` | *Optional[str]* | ➖ | Schema description for the model | A mathematical response | +| `name` | *str* | ✅ | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | +| `schema_` | Dict[str, *Any*] | ➖ | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | +| `strict` | *OptionalNullable[bool]* | ➖ | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/components/chatnamedtoolchoice.mdx b/docs/components/chatnamedtoolchoice.mdx index 1c98093bf..a806b92c2 100644 --- a/docs/components/chatnamedtoolchoice.mdx +++ b/docs/components/chatnamedtoolchoice.mdx @@ -9,5 +9,5 @@ Named tool choice for specific function | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `function` | [components.ChatNamedToolChoiceFunction](../components/chatnamedtoolchoicefunction.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.ChatNamedToolChoiceType](../components/chatnamedtoolchoicetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `function` | [components.ChatNamedToolChoiceFunction](../components/chatnamedtoolchoicefunction.mdx) | ✅ | N/A | +| `type` | [components.ChatNamedToolChoiceType](../components/chatnamedtoolchoicetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chatnamedtoolchoicefunction.mdx b/docs/components/chatnamedtoolchoicefunction.mdx index 1824174f9..4f83f319d 100644 --- a/docs/components/chatnamedtoolchoicefunction.mdx +++ b/docs/components/chatnamedtoolchoicefunction.mdx @@ -6,4 +6,4 @@ title: "ChatNamedToolChoiceFunction" | Field | Type | Required | Description | Example | | --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *str* | :heavy_check_mark: | Function name to call | get_weather | \ No newline at end of file +| `name` | *str* | ✅ | Function name to call | get_weather | \ No newline at end of file diff --git a/docs/components/chatrequest.mdx b/docs/components/chatrequest.mdx index 229ea863b..b6c5a42b8 100644 --- a/docs/components/chatrequest.mdx +++ b/docs/components/chatrequest.mdx @@ -9,45 +9,45 @@ Chat completion request parameters | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.ChatDebugOptions]](../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `image_config` | Dict[str, [components.ImageConfig](../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"
} | -| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | -| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | -| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | -| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `messages` | List[[components.ChatMessages](../components/chatmessages.mdx)] | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | -| `metadata` | Dict[str, *str*] | :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"
} | -| `min_p` | *OptionalNullable[float]* | :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` | List[[components.Modality](../components/modality.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | -| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../components/chatrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `prediction` | [OptionalNullable[components.Prediction]](../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"
} | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [Optional[components.ChatRequestReasoning]](../components/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../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 | -| `repetition_penalty` | *OptionalNullable[float]* | :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 | -| `response_format` | [Optional[components.ResponseFormat]](../components/responseformat.mdx) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | -| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../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 | -| `session_id` | *Optional[str]* | :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[components.Stop]](../components/stop.mdx) | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.mdx) | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `tool_choice` | [Optional[components.ChatToolChoice]](../components/chattoolchoice.mdx) | :heavy_minus_sign: | Tool choice configuration | auto | -| `tools` | List[[components.ChatFunctionTool](../components/chatfunctiontool.mdx)] | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | -| `top_a` | *OptionalNullable[float]* | :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 | -| `top_k` | *OptionalNullable[int]* | :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 | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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 +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.ChatDebugOptions]](../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | ➖ | Frequency penalty (-2.0 to 2.0) | 0 | +| `image_config` | Dict[str, [components.ImageConfig](../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"
} | +| `logit_bias` | Dict[str, *float*] | ➖ | Token logit bias adjustments | \{
"50256": -100
} | +| `logprobs` | *OptionalNullable[bool]* | ➖ | Return log probabilities | false | +| `max_completion_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens in completion | 100 | +| `max_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | +| `messages` | List[[components.ChatMessages](../components/chatmessages.mdx)] | ✅ | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `metadata` | Dict[str, *str*] | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | +| `min_p` | *OptionalNullable[float]* | ➖ | 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` | List[[components.Modality](../components/modality.mdx)] | ➖ | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `model` | *Optional[str]* | ➖ | Model to use for completion | openai/gpt-4 | +| `models` | List[*str*] | ➖ | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | +| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../components/chatrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `prediction` | [OptionalNullable[components.Prediction]](../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"
} | +| `presence_penalty` | *OptionalNullable[float]* | ➖ | Presence penalty (-2.0 to 2.0) | 0 | +| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [Optional[components.ChatRequestReasoning]](../components/chatrequestreasoning.mdx) | ➖ | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../components/chatrequestreasoningeffort.mdx) | ➖ | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | +| `repetition_penalty` | *OptionalNullable[float]* | ➖ | 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 | +| `response_format` | [Optional[components.ResponseFormat]](../components/responseformat.mdx) | ➖ | Response format configuration | \{
"type": "json_object"
} | +| `seed` | *OptionalNullable[int]* | ➖ | Random seed for deterministic outputs | 42 | +| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../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 | +| `session_id` | *Optional[str]* | ➖ | 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[components.Stop]](../components/stop.mdx) | ➖ | Stop sequences (up to 4) | [
"\n"
] | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[bool]* | ➖ | Enable streaming response | false | +| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.mdx) | ➖ | Streaming configuration options | \{
"include_usage": true
} | +| `temperature` | *OptionalNullable[float]* | ➖ | Sampling temperature (0-2) | 0.7 | +| `tool_choice` | [Optional[components.ChatToolChoice]](../components/chattoolchoice.mdx) | ➖ | Tool choice configuration | auto | +| `tools` | List[[components.ChatFunctionTool](../components/chatfunctiontool.mdx)] | ➖ | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `top_a` | *OptionalNullable[float]* | ➖ | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | +| `top_k` | *OptionalNullable[int]* | ➖ | 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 | +| `top_logprobs` | *OptionalNullable[int]* | ➖ | Number of top log probabilities to return (0-20) | 5 | +| `top_p` | *OptionalNullable[float]* | ➖ | Nucleus sampling parameter (0-1) | 1 | +| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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/components/chatrequestreasoning.mdx b/docs/components/chatrequestreasoning.mdx index d9a271d74..1c04df67a 100644 --- a/docs/components/chatrequestreasoning.mdx +++ b/docs/components/chatrequestreasoning.mdx @@ -9,5 +9,5 @@ Configuration options for reasoning models | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.ChatRequestEffort]](../components/chatrequesteffort.mdx) | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | -| `summary` | [OptionalNullable[components.ChatReasoningSummaryVerbosityEnum]](../components/chatreasoningsummaryverbosityenum.mdx) | :heavy_minus_sign: | N/A | concise | \ No newline at end of file +| `effort` | [OptionalNullable[components.ChatRequestEffort]](../components/chatrequesteffort.mdx) | ➖ | Constrains effort on reasoning for reasoning models | medium | +| `summary` | [OptionalNullable[components.ChatReasoningSummaryVerbosityEnum]](../components/chatreasoningsummaryverbosityenum.mdx) | ➖ | N/A | concise | \ No newline at end of file diff --git a/docs/components/chatresult.mdx b/docs/components/chatresult.mdx index 3f20da648..79c894f26 100644 --- a/docs/components/chatresult.mdx +++ b/docs/components/chatresult.mdx @@ -9,12 +9,12 @@ Chat completion response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | List[[components.ChatChoice](../components/chatchoice.mdx)] | :heavy_check_mark: | List of completion choices | | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `id` | *str* | :heavy_check_mark: | Unique completion identifier | chatcmpl-123 | -| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [components.ChatResultObject](../components/chatresultobject.mdx) | :heavy_check_mark: | N/A | | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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"
} | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `system_fingerprint` | *Nullable[str]* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb | -| `usage` | [Optional[components.ChatUsage]](../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` | List[[components.ChatChoice](../components/chatchoice.mdx)] | ✅ | List of completion choices | | +| `created` | *int* | ✅ | Unix timestamp of creation | 1677652288 | +| `id` | *str* | ✅ | Unique completion identifier | chatcmpl-123 | +| `model` | *str* | ✅ | Model used for completion | openai/gpt-4 | +| `object` | [components.ChatResultObject](../components/chatresultobject.mdx) | ✅ | N/A | | +| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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"
} | +| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | default | +| `system_fingerprint` | *Nullable[str]* | ✅ | System fingerprint | fp_44709d6fcb | +| `usage` | [Optional[components.ChatUsage]](../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/components/chatsearchmodelsservertool.mdx b/docs/components/chatsearchmodelsservertool.mdx index 18b2f4e1a..4acc95750 100644 --- a/docs/components/chatsearchmodelsservertool.mdx +++ b/docs/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` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [components.ChatSearchModelsServerToolType](../components/chatsearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [components.ChatSearchModelsServerToolType](../components/chatsearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/chatservertoolchoice.mdx b/docs/components/chatservertoolchoice.mdx index 9eac8152d..444efbbfa 100644 --- a/docs/components/chatservertoolchoice.mdx +++ b/docs/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` | *str* | :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` | *str* | ✅ | 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/components/chatstreamchoice.mdx b/docs/components/chatstreamchoice.mdx index d6bd70fb2..1454ec663 100644 --- a/docs/components/chatstreamchoice.mdx +++ b/docs/components/chatstreamchoice.mdx @@ -9,7 +9,7 @@ Streaming completion choice chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `delta` | [components.ChatStreamDelta](../components/chatstreamdelta.mdx) | :heavy_check_mark: | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | -| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | -| `index` | *int* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../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](../components/chatstreamdelta.mdx) | ✅ | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | +| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.mdx) | ✅ | N/A | stop | +| `index` | *int* | ✅ | Choice index | 0 | +| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../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/components/chatstreamchunk.mdx b/docs/components/chatstreamchunk.mdx index ccddb5a2b..b80260437 100644 --- a/docs/components/chatstreamchunk.mdx +++ b/docs/components/chatstreamchunk.mdx @@ -9,13 +9,13 @@ Streaming chat completion chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | List[[components.ChatStreamChoice](../components/chatstreamchoice.mdx)] | :heavy_check_mark: | List of streaming chunk choices | | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `error` | [Optional[components.ChatStreamChunkError]](../components/chatstreamchunkerror.mdx) | :heavy_minus_sign: | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | -| `id` | *str* | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 | -| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [components.ChatStreamChunkObject](../components/chatstreamchunkobject.mdx) | :heavy_check_mark: | N/A | | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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"
} | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | -| `usage` | [Optional[components.ChatUsage]](../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` | List[[components.ChatStreamChoice](../components/chatstreamchoice.mdx)] | ✅ | List of streaming chunk choices | | +| `created` | *int* | ✅ | Unix timestamp of creation | 1677652288 | +| `error` | [Optional[components.ChatStreamChunkError]](../components/chatstreamchunkerror.mdx) | ➖ | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | +| `id` | *str* | ✅ | Unique chunk identifier | chatcmpl-123 | +| `model` | *str* | ✅ | Model used for completion | openai/gpt-4 | +| `object` | [components.ChatStreamChunkObject](../components/chatstreamchunkobject.mdx) | ✅ | N/A | | +| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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"
} | +| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | default | +| `system_fingerprint` | *Optional[str]* | ➖ | System fingerprint | fp_44709d6fcb | +| `usage` | [Optional[components.ChatUsage]](../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/components/chatstreamchunkerror.mdx b/docs/components/chatstreamchunkerror.mdx index e04b55b06..b505cee0f 100644 --- a/docs/components/chatstreamchunkerror.mdx +++ b/docs/components/chatstreamchunkerror.mdx @@ -9,6 +9,6 @@ Error information | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `code` | *int* | :heavy_check_mark: | Error code | 429 | -| `message` | *str* | :heavy_check_mark: | Error message | Rate limit exceeded | -| `metadata` | [Optional[components.ChatStreamChunkMetadata]](../components/chatstreamchunkmetadata.mdx) | :heavy_minus_sign: | Structured error metadata | | \ No newline at end of file +| `code` | *int* | ✅ | Error code | 429 | +| `message` | *str* | ✅ | Error message | Rate limit exceeded | +| `metadata` | [Optional[components.ChatStreamChunkMetadata]](../components/chatstreamchunkmetadata.mdx) | ➖ | Structured error metadata | | \ No newline at end of file diff --git a/docs/components/chatstreamchunkmetadata.mdx b/docs/components/chatstreamchunkmetadata.mdx index ce80e38c1..8a94144ad 100644 --- a/docs/components/chatstreamchunkmetadata.mdx +++ b/docs/components/chatstreamchunkmetadata.mdx @@ -9,5 +9,5 @@ Structured error metadata | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `error_type` | [components.APIErrorType](../components/apierrortype.mdx) | :heavy_check_mark: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `provider_code` | *Optional[str]* | :heavy_minus_sign: | Upstream provider-specific error code, when available | | \ No newline at end of file +| `error_type` | [components.APIErrorType](../components/apierrortype.mdx) | ✅ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `provider_code` | *Optional[str]* | ➖ | Upstream provider-specific error code, when available | | \ No newline at end of file diff --git a/docs/components/chatstreamdelta.mdx b/docs/components/chatstreamdelta.mdx index 3ac2bd92b..96d2d54bf 100644 --- a/docs/components/chatstreamdelta.mdx +++ b/docs/components/chatstreamdelta.mdx @@ -9,10 +9,10 @@ Delta changes in streaming response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [Optional[components.ChatAudioOutput]](../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[str]* | :heavy_minus_sign: | Message content delta | Hello | -| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to | -| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.mdx)] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | -| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | null | -| `role` | [Optional[components.ChatStreamDeltaRole]](../components/chatstreamdeltarole.mdx) | :heavy_minus_sign: | The role of the message author | assistant | -| `tool_calls` | List[[components.ChatStreamToolCall](../components/chatstreamtoolcall.mdx)] | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file +| `audio` | [Optional[components.ChatAudioOutput]](../components/chataudiooutput.mdx) | ➖ | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | +| `content` | *OptionalNullable[str]* | ➖ | Message content delta | Hello | +| `reasoning` | *OptionalNullable[str]* | ➖ | Reasoning content delta | I need to | +| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.mdx)] | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | +| `refusal` | *OptionalNullable[str]* | ➖ | Refusal message delta | null | +| `role` | [Optional[components.ChatStreamDeltaRole]](../components/chatstreamdeltarole.mdx) | ➖ | The role of the message author | assistant | +| `tool_calls` | List[[components.ChatStreamToolCall](../components/chatstreamtoolcall.mdx)] | ➖ | Tool calls delta | | \ No newline at end of file diff --git a/docs/components/chatstreamingresponse.mdx b/docs/components/chatstreamingresponse.mdx index bd7543c94..cb5cff0c7 100644 --- a/docs/components/chatstreamingresponse.mdx +++ b/docs/components/chatstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ChatStreamingResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ChatStreamChunk](../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](../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/components/chatstreamoptions.mdx b/docs/components/chatstreamoptions.mdx index 430faf2a0..cd099d499 100644 --- a/docs/components/chatstreamoptions.mdx +++ b/docs/components/chatstreamoptions.mdx @@ -9,4 +9,4 @@ Streaming configuration options | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ~~`include_usage`~~ | *Optional[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 +| ~~`include_usage`~~ | *Optional[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/components/chatstreamtoolcall.mdx b/docs/components/chatstreamtoolcall.mdx index beba823a6..5a4327a1a 100644 --- a/docs/components/chatstreamtoolcall.mdx +++ b/docs/components/chatstreamtoolcall.mdx @@ -9,7 +9,7 @@ Tool call delta for streaming responses | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `function` | [Optional[components.ChatStreamToolCallFunction]](../components/chatstreamtoolcallfunction.mdx) | :heavy_minus_sign: | Function call details | | -| `id` | *Optional[str]* | :heavy_minus_sign: | Tool call identifier | call_abc123 | -| `index` | *int* | :heavy_check_mark: | Tool call index in the array | 0 | -| `type` | [Optional[components.ChatStreamToolCallType]](../components/chatstreamtoolcalltype.mdx) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file +| `function` | [Optional[components.ChatStreamToolCallFunction]](../components/chatstreamtoolcallfunction.mdx) | ➖ | Function call details | | +| `id` | *Optional[str]* | ➖ | Tool call identifier | call_abc123 | +| `index` | *int* | ✅ | Tool call index in the array | 0 | +| `type` | [Optional[components.ChatStreamToolCallType]](../components/chatstreamtoolcalltype.mdx) | ➖ | Tool call type | function | \ No newline at end of file diff --git a/docs/components/chatstreamtoolcallfunction.mdx b/docs/components/chatstreamtoolcallfunction.mdx index 12a71db2d..59f94e221 100644 --- a/docs/components/chatstreamtoolcallfunction.mdx +++ b/docs/components/chatstreamtoolcallfunction.mdx @@ -9,5 +9,5 @@ Function call details | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *Optional[str]* | :heavy_minus_sign: | Function arguments as JSON string | \{"location": "..."} | -| `name` | *Optional[str]* | :heavy_minus_sign: | Function name | get_weather | \ No newline at end of file +| `arguments` | *Optional[str]* | ➖ | Function arguments as JSON string | \{"location": "..."} | +| `name` | *Optional[str]* | ➖ | Function name | get_weather | \ No newline at end of file diff --git a/docs/components/chatsystemmessage.mdx b/docs/components/chatsystemmessage.mdx index d904f59d2..b29202ee8 100644 --- a/docs/components/chatsystemmessage.mdx +++ b/docs/components/chatsystemmessage.mdx @@ -9,7 +9,7 @@ System message for setting behavior | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration_update` | [OptionalNullable[components.ChatSystemMessageConfigurationUpdate]](../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](../components/chatsystemmessagecontent.mdx) | :heavy_check_mark: | System message content | You are a helpful assistant. | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the system message | Assistant Config | -| `role` | [components.ChatSystemMessageRole](../components/chatsystemmessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `configuration_update` | [OptionalNullable[components.ChatSystemMessageConfigurationUpdate]](../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](../components/chatsystemmessagecontent.mdx) | ✅ | System message content | You are a helpful assistant. | +| `name` | *Optional[str]* | ➖ | Optional name for the system message | Assistant Config | +| `role` | [components.ChatSystemMessageRole](../components/chatsystemmessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/chatsystemmessageconfigurationupdate.mdx b/docs/components/chatsystemmessageconfigurationupdate.mdx index 31dd268a4..e9b57360b 100644 --- a/docs/components/chatsystemmessageconfigurationupdate.mdx +++ b/docs/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](../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](../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/components/chattokenlogprob.mdx b/docs/components/chattokenlogprob.mdx index f6b39af96..2f18f3f90 100644 --- a/docs/components/chattokenlogprob.mdx +++ b/docs/components/chattokenlogprob.mdx @@ -9,7 +9,7 @@ Token log probability information | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | UTF-8 bytes of the token | -| `logprob` | *float* | :heavy_check_mark: | Log probability of the token | -| `token` | *str* | :heavy_check_mark: | The token | -| `top_logprobs` | List[[components.ChatTokenLogprobTopLogprob](../components/chattokenlogprobtoplogprob.mdx)] | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file +| `bytes_` | List[*int*] | ✅ | UTF-8 bytes of the token | +| `logprob` | *float* | ✅ | Log probability of the token | +| `token` | *str* | ✅ | The token | +| `top_logprobs` | List[[components.ChatTokenLogprobTopLogprob](../components/chattokenlogprobtoplogprob.mdx)] | ✅ | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/docs/components/chattokenlogprobs.mdx b/docs/components/chattokenlogprobs.mdx index 068610e7a..20701c1da 100644 --- a/docs/components/chattokenlogprobs.mdx +++ b/docs/components/chattokenlogprobs.mdx @@ -9,5 +9,5 @@ Log probabilities for the completion | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `content` | List[[components.ChatTokenLogprob](../components/chattokenlogprob.mdx)] | :heavy_check_mark: | Log probabilities for content tokens | -| `refusal` | List[[components.ChatTokenLogprob](../components/chattokenlogprob.mdx)] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file +| `content` | List[[components.ChatTokenLogprob](../components/chattokenlogprob.mdx)] | ✅ | Log probabilities for content tokens | +| `refusal` | List[[components.ChatTokenLogprob](../components/chattokenlogprob.mdx)] | ➖ | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/docs/components/chattokenlogprobtoplogprob.mdx b/docs/components/chattokenlogprobtoplogprob.mdx index 89813675b..b167ece21 100644 --- a/docs/components/chattokenlogprobtoplogprob.mdx +++ b/docs/components/chattokenlogprobtoplogprob.mdx @@ -6,6 +6,6 @@ title: "ChatTokenLogprobTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | ✅ | N/A | +| `logprob` | *float* | ✅ | N/A | +| `token` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chattoolcall.mdx b/docs/components/chattoolcall.mdx index 09bffc9d9..54f6698ac 100644 --- a/docs/components/chattoolcall.mdx +++ b/docs/components/chattoolcall.mdx @@ -9,6 +9,6 @@ Tool call made by the assistant | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `function` | [components.ChatToolCallFunction](../components/chattoolcallfunction.mdx) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | Tool call identifier | -| `type` | [components.ChatToolCallType](../components/chattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `function` | [components.ChatToolCallFunction](../components/chattoolcallfunction.mdx) | ✅ | N/A | +| `id` | *str* | ✅ | Tool call identifier | +| `type` | [components.ChatToolCallType](../components/chattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/chattoolcallfunction.mdx b/docs/components/chattoolcallfunction.mdx index bf3ffcadc..f60699894 100644 --- a/docs/components/chattoolcallfunction.mdx +++ b/docs/components/chattoolcallfunction.mdx @@ -6,5 +6,5 @@ title: "ChatToolCallFunction" | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | Function arguments as JSON string | -| `name` | *str* | :heavy_check_mark: | Function name to call | \ No newline at end of file +| `arguments` | *str* | ✅ | Function arguments as JSON string | +| `name` | *str* | ✅ | Function name to call | \ No newline at end of file diff --git a/docs/components/chattoolmessage.mdx b/docs/components/chattoolmessage.mdx index bd39bbff2..190aac46f 100644 --- a/docs/components/chattoolmessage.mdx +++ b/docs/components/chattoolmessage.mdx @@ -9,6 +9,6 @@ Tool response message | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `content` | [components.ChatToolMessageContent](../components/chattoolmessagecontent.mdx) | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | -| `role` | [components.ChatToolMessageRole](../components/chattoolmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `tool_call_id` | *str* | :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](../components/chattoolmessagecontent.mdx) | ✅ | Tool response content | The weather in San Francisco is 72°F and sunny. | +| `role` | [components.ChatToolMessageRole](../components/chattoolmessagerole.mdx) | ✅ | N/A | | +| `tool_call_id` | *str* | ✅ | ID of the assistant message tool call this message responds to | call_abc123 | \ No newline at end of file diff --git a/docs/components/chatusage.mdx b/docs/components/chatusage.mdx index a32fff446..51d9a7d64 100644 --- a/docs/components/chatusage.mdx +++ b/docs/components/chatusage.mdx @@ -9,12 +9,12 @@ Token usage statistics | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `completion_tokens` | *int* | :heavy_check_mark: | Number of tokens in the completion | | -| `completion_tokens_details` | [OptionalNullable[components.ChatUsageCompletionTokensDetails]](../components/chatusagecompletiontokensdetails.mdx) | :heavy_minus_sign: | Detailed completion token usage | | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `prompt_tokens` | *int* | :heavy_check_mark: | Number of tokens in the prompt | | -| `prompt_tokens_details` | [OptionalNullable[components.ChatUsagePromptTokensDetails]](../components/chatusageprompttokensdetails.mdx) | :heavy_minus_sign: | Detailed prompt token usage | | -| `server_tool_use_details` | [OptionalNullable[components.ServerToolUseDetails]](../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
} | -| `total_tokens` | *int* | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file +| `completion_tokens` | *int* | ✅ | Number of tokens in the completion | | +| `completion_tokens_details` | [OptionalNullable[components.ChatUsageCompletionTokensDetails]](../components/chatusagecompletiontokensdetails.mdx) | ➖ | Detailed completion token usage | | +| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `prompt_tokens` | *int* | ✅ | Number of tokens in the prompt | | +| `prompt_tokens_details` | [OptionalNullable[components.ChatUsagePromptTokensDetails]](../components/chatusageprompttokensdetails.mdx) | ➖ | Detailed prompt token usage | | +| `server_tool_use_details` | [OptionalNullable[components.ServerToolUseDetails]](../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
} | +| `total_tokens` | *int* | ✅ | Total number of tokens | | \ No newline at end of file diff --git a/docs/components/chatusagecompletiontokensdetails.mdx b/docs/components/chatusagecompletiontokensdetails.mdx index 6ac1392b3..579a30a6d 100644 --- a/docs/components/chatusagecompletiontokensdetails.mdx +++ b/docs/components/chatusagecompletiontokensdetails.mdx @@ -9,7 +9,7 @@ Detailed completion token usage | Field | Type | Required | Description | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `accepted_prediction_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Accepted prediction tokens | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for audio output | -| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for reasoning | -| `rejected_prediction_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Rejected prediction tokens | \ No newline at end of file +| `accepted_prediction_tokens` | *OptionalNullable[int]* | ➖ | Accepted prediction tokens | +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for audio output | +| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for reasoning | +| `rejected_prediction_tokens` | *OptionalNullable[int]* | ➖ | Rejected prediction tokens | \ No newline at end of file diff --git a/docs/components/chatusageprompttokensdetails.mdx b/docs/components/chatusageprompttokensdetails.mdx index 0f5dac4b5..f53ccc962 100644 --- a/docs/components/chatusageprompttokensdetails.mdx +++ b/docs/components/chatusageprompttokensdetails.mdx @@ -9,7 +9,7 @@ Detailed prompt token usage | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *Optional[int]* | :heavy_minus_sign: | Audio input tokens | -| `cache_write_tokens` | *Optional[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *Optional[int]* | :heavy_minus_sign: | Cached prompt tokens | -| `video_tokens` | *Optional[int]* | :heavy_minus_sign: | Video input tokens | \ No newline at end of file +| `audio_tokens` | *Optional[int]* | ➖ | Audio input tokens | +| `cache_write_tokens` | *Optional[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *Optional[int]* | ➖ | Cached prompt tokens | +| `video_tokens` | *Optional[int]* | ➖ | Video input tokens | \ No newline at end of file diff --git a/docs/components/chatusermessage.mdx b/docs/components/chatusermessage.mdx index 3b6546aa3..3ec478d05 100644 --- a/docs/components/chatusermessage.mdx +++ b/docs/components/chatusermessage.mdx @@ -9,6 +9,6 @@ User message | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `content` | [components.ChatUserMessageContent](../components/chatusermessagecontent.mdx) | :heavy_check_mark: | User message content | What is the capital of France? | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the user | User | -| `role` | [components.ChatUserMessageRole](../components/chatusermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [components.ChatUserMessageContent](../components/chatusermessagecontent.mdx) | ✅ | User message content | What is the capital of France? | +| `name` | *Optional[str]* | ➖ | Optional name for the user | User | +| `role` | [components.ChatUserMessageRole](../components/chatusermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/chatwebsearchshorthand.mdx b/docs/components/chatwebsearchshorthand.mdx index ae3a68743..a6e1c059d 100644 --- a/docs/components/chatwebsearchshorthand.mdx +++ b/docs/components/chatwebsearchshorthand.mdx @@ -9,16 +9,16 @@ Web search tool using OpenAI Responses API syntax. Automatically converted to op | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :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` | [Optional[components.WebSearchEngineEnum]](../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 | -| `excluded_domains` | List[*str*] | :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. | | -| `max_characters` | *Optional[int]* | :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 | -| `max_results` | *Optional[int]* | :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 | -| `max_total_results` | *Optional[int]* | :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 | -| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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` | [Optional[components.WebSearchConfig]](../components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `search_context_size` | [Optional[components.SearchQualityLevel]](../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](../components/chatwebsearchshorthandtype.mdx) | :heavy_check_mark: | N/A | | -| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../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"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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 +| `allowed_domains` | List[*str*] | ➖ | 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` | [Optional[components.WebSearchEngineEnum]](../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 | +| `excluded_domains` | List[*str*] | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `max_characters` | *Optional[int]* | ➖ | 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 | +| `max_results` | *Optional[int]* | ➖ | 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 | +| `max_total_results` | *Optional[int]* | ➖ | 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 | +| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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` | [Optional[components.WebSearchConfig]](../components/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `search_context_size` | [Optional[components.SearchQualityLevel]](../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](../components/chatwebsearchshorthandtype.mdx) | ✅ | N/A | | +| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/choice.mdx b/docs/components/choice.mdx index 09102913c..db64a2a1a 100644 --- a/docs/components/choice.mdx +++ b/docs/components/choice.mdx @@ -6,8 +6,8 @@ title: "Choice" | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `finish_reason` | [components.FinishReason](../components/finishreason.mdx) | :heavy_check_mark: | N/A | stop | -| `index` | *int* | :heavy_check_mark: | N/A | | -| `logprobs` | [Nullable[components.Logprobs]](../components/logprobs.mdx) | :heavy_check_mark: | N/A | | -| `message` | [components.Message](../components/message.mdx) | :heavy_check_mark: | N/A | | -| `native_finish_reason` | *Nullable[str]* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `finish_reason` | [components.FinishReason](../components/finishreason.mdx) | ✅ | N/A | stop | +| `index` | *int* | ✅ | N/A | | +| `logprobs` | [Nullable[components.Logprobs]](../components/logprobs.mdx) | ✅ | N/A | | +| `message` | [components.Message](../components/message.mdx) | ✅ | N/A | | +| `native_finish_reason` | *Nullable[str]* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/codeinterpretercallcodedeltaevent.mdx b/docs/components/codeinterpretercallcodedeltaevent.mdx index 70e78af03..78db21e41 100644 --- a/docs/components/codeinterpretercallcodedeltaevent.mdx +++ b/docs/components/codeinterpretercallcodedeltaevent.mdx @@ -9,8 +9,8 @@ Incremental chunk of code being streamed for a `code_interpreter_call`. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.CodeInterpreterCallCodeDeltaEventType](../components/codeinterpretercallcodedeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.CodeInterpreterCallCodeDeltaEventType](../components/codeinterpretercallcodedeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpretercallcodedoneevent.mdx b/docs/components/codeinterpretercallcodedoneevent.mdx index d7bc2ec6b..09a6ebca0 100644 --- a/docs/components/codeinterpretercallcodedoneevent.mdx +++ b/docs/components/codeinterpretercallcodedoneevent.mdx @@ -9,8 +9,8 @@ Emitted when code streaming completes for a `code_interpreter_call`. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `code` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.CodeInterpreterCallCodeDoneEventType](../components/codeinterpretercallcodedoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.CodeInterpreterCallCodeDoneEventType](../components/codeinterpretercallcodedoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpretercallcompletedevent.mdx b/docs/components/codeinterpretercallcompletedevent.mdx index 0589dc6b4..693b2b709 100644 --- a/docs/components/codeinterpretercallcompletedevent.mdx +++ b/docs/components/codeinterpretercallcompletedevent.mdx @@ -9,7 +9,7 @@ Code interpreter call completed | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.CodeInterpreterCallCompletedEventType](../components/codeinterpretercallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.CodeInterpreterCallCompletedEventType](../components/codeinterpretercallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpretercallinprogressevent.mdx b/docs/components/codeinterpretercallinprogressevent.mdx index 0c1876df6..3edcaa3a1 100644 --- a/docs/components/codeinterpretercallinprogressevent.mdx +++ b/docs/components/codeinterpretercallinprogressevent.mdx @@ -9,7 +9,7 @@ Code interpreter call in progress | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.CodeInterpreterCallInProgressEventType](../components/codeinterpretercallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.CodeInterpreterCallInProgressEventType](../components/codeinterpretercallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpretercallinterpretingevent.mdx b/docs/components/codeinterpretercallinterpretingevent.mdx index 92fb7446f..9c4d17ab6 100644 --- a/docs/components/codeinterpretercallinterpretingevent.mdx +++ b/docs/components/codeinterpretercallinterpretingevent.mdx @@ -9,7 +9,7 @@ Code interpreter is executing the code | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.CodeInterpreterCallInterpretingEventType](../components/codeinterpretercallinterpretingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.CodeInterpreterCallInterpretingEventType](../components/codeinterpretercallinterpretingeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpreterfileoutput.mdx b/docs/components/codeinterpreterfileoutput.mdx index 623e61267..e78a0b94f 100644 --- a/docs/components/codeinterpreterfileoutput.mdx +++ b/docs/components/codeinterpreterfileoutput.mdx @@ -6,13 +6,13 @@ title: "CodeInterpreterFileOutput" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `download_url` | *Optional[str]* | :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. | -| `error_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Provider error code when generating or persisting the file failed; null or absent on success. | -| `expires_at` | *Optional[str]* | :heavy_minus_sign: | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | -| `filename` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `media_type` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `sha256` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `size_bytes` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `status` | *Optional[str]* | :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](../components/codeinterpreterfileoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `download_url` | *Optional[str]* | ➖ | Provider-issued download URL for the generated file. Typically signed and time-limited (see `expires_at`); fetch promptly rather than persisting the URL. | +| `error_code` | *OptionalNullable[str]* | ➖ | Provider error code when generating or persisting the file failed; null or absent on success. | +| `expires_at` | *Optional[str]* | ➖ | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | +| `filename` | *Optional[str]* | ➖ | N/A | +| `id` | *Optional[str]* | ➖ | N/A | +| `media_type` | *Optional[str]* | ➖ | N/A | +| `sha256` | *Optional[str]* | ➖ | N/A | +| `size_bytes` | *Optional[int]* | ➖ | N/A | +| `status` | *Optional[str]* | ➖ | Provider-reported readiness of the generated file (e.g. `ready`). Values other than `ready` indicate the artifact may not be downloadable. | +| `type` | [components.CodeInterpreterFileOutputType](../components/codeinterpreterfileoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpreterimageoutput.mdx b/docs/components/codeinterpreterimageoutput.mdx index e259d6ef5..f8487fc71 100644 --- a/docs/components/codeinterpreterimageoutput.mdx +++ b/docs/components/codeinterpreterimageoutput.mdx @@ -6,5 +6,5 @@ title: "CodeInterpreterImageOutput" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | [components.CodeInterpreterImageOutputType](../components/codeinterpreterimageoutputtype.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.CodeInterpreterImageOutputType](../components/codeinterpreterimageoutputtype.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpreterlogsoutput.mdx b/docs/components/codeinterpreterlogsoutput.mdx index 9ac144a81..6e6cf93ae 100644 --- a/docs/components/codeinterpreterlogsoutput.mdx +++ b/docs/components/codeinterpreterlogsoutput.mdx @@ -6,5 +6,5 @@ title: "CodeInterpreterLogsOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `logs` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.CodeInterpreterLogsOutputType](../components/codeinterpreterlogsoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `logs` | *str* | ✅ | N/A | +| `type` | [components.CodeInterpreterLogsOutputType](../components/codeinterpreterlogsoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/codeinterpreterservertool.mdx b/docs/components/codeinterpreterservertool.mdx index 952662124..a3ceace7d 100644 --- a/docs/components/codeinterpreterservertool.mdx +++ b/docs/components/codeinterpreterservertool.mdx @@ -9,5 +9,5 @@ Code interpreter tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `container` | [components.Container](../components/container.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.TypeCodeInterpreter](../components/typecodeinterpreter.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container` | [components.Container](../components/container.mdx) | ✅ | N/A | +| `type` | [components.TypeCodeInterpreter](../components/typecodeinterpreter.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/codexlocalshelltool.mdx b/docs/components/codexlocalshelltool.mdx index f5b8e9d3c..62e00b6ee 100644 --- a/docs/components/codexlocalshelltool.mdx +++ b/docs/components/codexlocalshelltool.mdx @@ -9,4 +9,4 @@ Local shell tool configuration | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `type` | [components.CodexLocalShellToolType](../components/codexlocalshelltooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.CodexLocalShellToolType](../components/codexlocalshelltooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/compactionitem.mdx b/docs/components/compactionitem.mdx index 313c76b10..04a99b493 100644 --- a/docs/components/compactionitem.mdx +++ b/docs/components/compactionitem.mdx @@ -9,7 +9,7 @@ A context compaction marker with encrypted summary | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `encrypted_content` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.CompactionItemType](../components/compactionitemtype.mdx) | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file +| `encrypted_content` | *str* | ✅ | N/A | | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `type` | [components.CompactionItemType](../components/compactionitemtype.mdx) | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file diff --git a/docs/components/compoundfilter.mdx b/docs/components/compoundfilter.mdx index 31f3a0631..809ceef34 100644 --- a/docs/components/compoundfilter.mdx +++ b/docs/components/compoundfilter.mdx @@ -9,5 +9,5 @@ A compound filter that combines multiple comparison or compound filters | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `filters` | List[Dict[str, *Any*]] | :heavy_check_mark: | N/A | -| `type` | [components.CompoundFilterType](../components/compoundfiltertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `filters` | List[Dict[str, *Any*]] | ✅ | N/A | +| `type` | [components.CompoundFilterType](../components/compoundfiltertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/computeruseservertool.mdx b/docs/components/computeruseservertool.mdx index 3021debd9..87de2572a 100644 --- a/docs/components/computeruseservertool.mdx +++ b/docs/components/computeruseservertool.mdx @@ -9,7 +9,7 @@ Computer use preview tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `display_height` | *int* | :heavy_check_mark: | N/A | -| `display_width` | *int* | :heavy_check_mark: | N/A | -| `environment` | [components.Environment](../components/environment.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.ComputerUseServerToolType](../components/computeruseservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `display_height` | *int* | ✅ | N/A | +| `display_width` | *int* | ✅ | N/A | +| `environment` | [components.Environment](../components/environment.mdx) | ✅ | N/A | +| `type` | [components.ComputerUseServerToolType](../components/computeruseservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/configurationupdateitem.mdx b/docs/components/configurationupdateitem.mdx index fdba8d18c..7a7e28631 100644 --- a/docs/components/configurationupdateitem.mdx +++ b/docs/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[str]* | :heavy_minus_sign: | N/A | | -| `reasoning` | [components.ConfigurationUpdateReasoning](../components/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | -| `type` | [components.ConfigurationUpdateItemType](../components/configurationupdateitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `reasoning` | [components.ConfigurationUpdateReasoning](../components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | +| `type` | [components.ConfigurationUpdateItemType](../components/configurationupdateitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/configurationupdatereasoning.mdx b/docs/components/configurationupdatereasoning.mdx index 3b99a0e51..c570d32fa 100644 --- a/docs/components/configurationupdatereasoning.mdx +++ b/docs/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](../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](../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/components/conflictresponseerrordata.mdx b/docs/components/conflictresponseerrordata.mdx index 6216c3834..9f26ef4d9 100644 --- a/docs/components/conflictresponseerrordata.mdx +++ b/docs/components/conflictresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ConflictResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/containerauto.mdx b/docs/components/containerauto.mdx index 00e55b66a..cde390a4f 100644 --- a/docs/components/containerauto.mdx +++ b/docs/components/containerauto.mdx @@ -6,6 +6,6 @@ title: "ContainerAuto" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `file_ids` | List[*str*] | :heavy_minus_sign: | N/A | -| `memory_limit` | [OptionalNullable[components.MemoryLimit]](../components/memorylimit.mdx) | :heavy_minus_sign: | N/A | -| `type` | [components.ContainerType](../components/containertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file_ids` | List[*str*] | ➖ | N/A | +| `memory_limit` | [OptionalNullable[components.MemoryLimit]](../components/memorylimit.mdx) | ➖ | N/A | +| `type` | [components.ContainerType](../components/containertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/containerautoenvironment.mdx b/docs/components/containerautoenvironment.mdx index b4e599c19..fd04bc26e 100644 --- a/docs/components/containerautoenvironment.mdx +++ b/docs/components/containerautoenvironment.mdx @@ -9,6 +9,6 @@ An OpenRouter-managed, auto-provisioned ephemeral container. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file_ids` | List[*str*] | :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"
] | -| `network_policy` | [Optional[components.ContainerNetworkPolicy]](../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](../components/containerautoenvironmenttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `file_ids` | List[*str*] | ➖ | 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"
] | +| `network_policy` | [Optional[components.ContainerNetworkPolicy]](../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](../components/containerautoenvironmenttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/containerfile.mdx b/docs/components/containerfile.mdx index 63e4189bb..6d8f3b4c5 100644 --- a/docs/components/containerfile.mdx +++ b/docs/components/containerfile.mdx @@ -6,10 +6,10 @@ title: "ContainerFile" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `bytes_` | *int* | :heavy_check_mark: | File size in bytes. | 123 | -| `container_id` | *str* | :heavy_check_mark: | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | -| `created_at` | *int* | :heavy_check_mark: | Unix timestamp (seconds) when the file was last synced. | 1755640000 | -| `id` | *str* | :heavy_check_mark: | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `object` | [components.ContainerFileObject](../components/containerfileobject.mdx) | :heavy_check_mark: | N/A | container.file | -| `path` | *str* | :heavy_check_mark: | Container-relative file path. | out/report.csv | -| `source` | [components.ContainerFileSource](../components/containerfilesource.mdx) | :heavy_check_mark: | Container files are always produced by the assistant sandbox. | assistant | \ No newline at end of file +| `bytes_` | *int* | ✅ | File size in bytes. | 123 | +| `container_id` | *str* | ✅ | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | +| `created_at` | *int* | ✅ | Unix timestamp (seconds) when the file was last synced. | 1755640000 | +| `id` | *str* | ✅ | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `object` | [components.ContainerFileObject](../components/containerfileobject.mdx) | ✅ | N/A | container.file | +| `path` | *str* | ✅ | Container-relative file path. | out/report.csv | +| `source` | [components.ContainerFileSource](../components/containerfilesource.mdx) | ✅ | Container files are always produced by the assistant sandbox. | assistant | \ No newline at end of file diff --git a/docs/components/containerfilelistresponse.mdx b/docs/components/containerfilelistresponse.mdx index 10eb459aa..f3924a018 100644 --- a/docs/components/containerfilelistresponse.mdx +++ b/docs/components/containerfilelistresponse.mdx @@ -6,8 +6,8 @@ title: "ContainerFileListResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.ContainerFile](../components/containerfile.mdx)] | :heavy_check_mark: | N/A | | -| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | -| `has_more` | *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 | -| `last_id` | *Nullable[str]* | :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](../components/containerfilelistresponseobject.mdx) | :heavy_check_mark: | N/A | list | \ No newline at end of file +| `data` | List[[components.ContainerFile](../components/containerfile.mdx)] | ✅ | N/A | | +| `first_id` | *Nullable[str]* | ✅ | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | +| `has_more` | *bool* | ✅ | True when another page can be fetched by passing `after=last_id`; `last_id` is non-null whenever this is true. | false | +| `last_id` | *Nullable[str]* | ✅ | 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](../components/containerfilelistresponseobject.mdx) | ✅ | N/A | list | \ No newline at end of file diff --git a/docs/components/containernetworkpolicyallowlist.mdx b/docs/components/containernetworkpolicyallowlist.mdx index 985509288..903c69971 100644 --- a/docs/components/containernetworkpolicyallowlist.mdx +++ b/docs/components/containernetworkpolicyallowlist.mdx @@ -6,5 +6,5 @@ title: "ContainerNetworkPolicyAllowlist" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_domains` | List[*str*] | :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](../components/typeallowlist.mdx) | :heavy_check_mark: | Outbound access restricted to the listed domains. | | \ No newline at end of file +| `allowed_domains` | List[*str*] | ✅ | 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](../components/typeallowlist.mdx) | ✅ | Outbound access restricted to the listed domains. | | \ No newline at end of file diff --git a/docs/components/containernetworkpolicydisabled.mdx b/docs/components/containernetworkpolicydisabled.mdx index a2e14bd56..5ca7f102f 100644 --- a/docs/components/containernetworkpolicydisabled.mdx +++ b/docs/components/containernetworkpolicydisabled.mdx @@ -6,4 +6,4 @@ title: "ContainerNetworkPolicyDisabled" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [components.ContainerNetworkPolicyTypeDisabled](../components/containernetworkpolicytypedisabled.mdx) | :heavy_check_mark: | No outbound internet access. | \ No newline at end of file +| `type` | [components.ContainerNetworkPolicyTypeDisabled](../components/containernetworkpolicytypedisabled.mdx) | ✅ | No outbound internet access. | \ No newline at end of file diff --git a/docs/components/containerreferenceenvironment.mdx b/docs/components/containerreferenceenvironment.mdx index cd619d6ae..9b4deaf6f 100644 --- a/docs/components/containerreferenceenvironment.mdx +++ b/docs/components/containerreferenceenvironment.mdx @@ -9,7 +9,7 @@ Reference to a container by its canonical id — a previously returned container | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | :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 | -| `file_ids` | List[*str*] | :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"
] | -| `network_policy` | [Optional[components.ContainerNetworkPolicy]](../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](../components/containerreferenceenvironmenttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `container_id` | *str* | ✅ | 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 | +| `file_ids` | List[*str*] | ➖ | 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"
] | +| `network_policy` | [Optional[components.ContainerNetworkPolicy]](../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](../components/containerreferenceenvironmenttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contentcompaction.mdx b/docs/components/contentcompaction.mdx index 805357e1f..e583353ce 100644 --- a/docs/components/contentcompaction.mdx +++ b/docs/components/contentcompaction.mdx @@ -6,7 +6,7 @@ title: "ContentCompaction" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.MessagesMessageParamTypeCompaction](../components/messagesmessageparamtypecompaction.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *Nullable[str]* | ✅ | N/A | | +| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | +| `type` | [components.MessagesMessageParamTypeCompaction](../components/messagesmessageparamtypecompaction.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contentencryptedcontent.mdx b/docs/components/contentencryptedcontent.mdx index 450638f0c..76af85cec 100644 --- a/docs/components/contentencryptedcontent.mdx +++ b/docs/components/contentencryptedcontent.mdx @@ -6,6 +6,6 @@ title: "ContentEncryptedContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `encrypted_content` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TypeEncryptedContent](../components/typeencryptedcontent.mdx) | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `encrypted_content` | *str* | ✅ | N/A | +| `type` | [components.TypeEncryptedContent](../components/typeencryptedcontent.mdx) | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/contentfilterbuiltinentry.mdx b/docs/components/contentfilterbuiltinentry.mdx index 48678dc2c..2696f30d9 100644 --- a/docs/components/contentfilterbuiltinentry.mdx +++ b/docs/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](../components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | -| `label` | *Optional[str]* | :heavy_minus_sign: | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | -| `scan_scope` | [Optional[components.PromptInjectionScanScope]](../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](../components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `action` | [components.ContentFilterBuiltinAction](../components/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | +| `label` | *Optional[str]* | ➖ | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | +| `scan_scope` | [Optional[components.PromptInjectionScanScope]](../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](../components/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/components/contentfilterbuiltinentryinput.mdx b/docs/components/contentfilterbuiltinentryinput.mdx index 28e250251..9753f4521 100644 --- a/docs/components/contentfilterbuiltinentryinput.mdx +++ b/docs/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](../components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | -| ~~`label`~~ | *Optional[str]* | :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. | | -| `scan_scope` | [Optional[components.PromptInjectionScanScope]](../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](../components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `action` | [components.ContentFilterBuiltinAction](../components/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | +| ~~`label`~~ | *Optional[str]* | ➖ | : 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. | | +| `scan_scope` | [Optional[components.PromptInjectionScanScope]](../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](../components/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/components/contentfilterentry.mdx b/docs/components/contentfilterentry.mdx index c8165e83a..0fe2bbd9f 100644 --- a/docs/components/contentfilterentry.mdx +++ b/docs/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](../components/contentfilteraction.mdx) | :heavy_check_mark: | Action taken when the pattern matches | block | -| `label` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional label used in redaction placeholders or error messages | [API_KEY] | -| `pattern` | *str* | :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](../components/contentfilteraction.mdx) | ✅ | Action taken when the pattern matches | block | +| `label` | *OptionalNullable[str]* | ➖ | Optional label used in redaction placeholders or error messages | [API_KEY] | +| `pattern` | *str* | ✅ | 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/components/contentimageurl.mdx b/docs/components/contentimageurl.mdx index 41aae9e0e..69aea2915 100644 --- a/docs/components/contentimageurl.mdx +++ b/docs/components/contentimageurl.mdx @@ -6,5 +6,5 @@ title: "ContentImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `image_url` | [components.ContentImageURLImageURL](../components/contentimageurlimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.FileTypeImageURL](../components/filetypeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `image_url` | [components.ContentImageURLImageURL](../components/contentimageurlimageurl.mdx) | ✅ | N/A | +| `type` | [components.FileTypeImageURL](../components/filetypeimageurl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentimageurlimageurl.mdx b/docs/components/contentimageurlimageurl.mdx index dc4af4688..272d214d6 100644 --- a/docs/components/contentimageurlimageurl.mdx +++ b/docs/components/contentimageurlimageurl.mdx @@ -6,4 +6,4 @@ title: "ContentImageURLImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentpartaddedevent.mdx b/docs/components/contentpartaddedevent.mdx index a62904e2c..1b157f83d 100644 --- a/docs/components/contentpartaddedevent.mdx +++ b/docs/components/contentpartaddedevent.mdx @@ -9,9 +9,9 @@ Event emitted when a new content part is added to an output item | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `part` | [components.ContentPartAddedEventPart](../components/contentpartaddedeventpart.mdx) | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ContentPartAddedEventType](../components/contentpartaddedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content_index` | *int* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `part` | [components.ContentPartAddedEventPart](../components/contentpartaddedeventpart.mdx) | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ContentPartAddedEventType](../components/contentpartaddedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentpartaudio.mdx b/docs/components/contentpartaudio.mdx index 1a97cd731..434006143 100644 --- a/docs/components/contentpartaudio.mdx +++ b/docs/components/contentpartaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartAudio" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `audio_url` | [components.AudioURL](../components/audiourl.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.ContentPartAudioType](../components/contentpartaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `audio_url` | [components.AudioURL](../components/audiourl.mdx) | ✅ | N/A | +| `type` | [components.ContentPartAudioType](../components/contentpartaudiotype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentpartdoneevent.mdx b/docs/components/contentpartdoneevent.mdx index 39c938493..2016f8ba0 100644 --- a/docs/components/contentpartdoneevent.mdx +++ b/docs/components/contentpartdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when a content part is complete | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `part` | [components.ContentPartDoneEventPart](../components/contentpartdoneeventpart.mdx) | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ContentPartDoneEventType](../components/contentpartdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content_index` | *int* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `part` | [components.ContentPartDoneEventPart](../components/contentpartdoneeventpart.mdx) | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ContentPartDoneEventType](../components/contentpartdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentpartimage.mdx b/docs/components/contentpartimage.mdx index d4adef710..6fbcf61db 100644 --- a/docs/components/contentpartimage.mdx +++ b/docs/components/contentpartimage.mdx @@ -6,5 +6,5 @@ title: "ContentPartImage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `image_url` | [components.ContentPartImageImageURL](../components/contentpartimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.ContentPartImageType](../components/contentpartimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `image_url` | [components.ContentPartImageImageURL](../components/contentpartimageimageurl.mdx) | ✅ | N/A | +| `type` | [components.ContentPartImageType](../components/contentpartimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentpartimageimageurl.mdx b/docs/components/contentpartimageimageurl.mdx index 248d1b880..91bbc14d0 100644 --- a/docs/components/contentpartimageimageurl.mdx +++ b/docs/components/contentpartimageimageurl.mdx @@ -6,4 +6,4 @@ title: "ContentPartImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentpartinputaudio.mdx b/docs/components/contentpartinputaudio.mdx index 08619de7f..a42a4daa9 100644 --- a/docs/components/contentpartinputaudio.mdx +++ b/docs/components/contentpartinputaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputAudio" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `input_audio` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `type` | [components.ContentPartInputAudioType](../components/contentpartinputaudiotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `input_audio` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `type` | [components.ContentPartInputAudioType](../components/contentpartinputaudiotype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contentpartinputfile.mdx b/docs/components/contentpartinputfile.mdx index de674503d..1037d15ca 100644 --- a/docs/components/contentpartinputfile.mdx +++ b/docs/components/contentpartinputfile.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputFile" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `input_file` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `type` | [components.ContentPartInputFileType](../components/contentpartinputfiletype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `input_file` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `type` | [components.ContentPartInputFileType](../components/contentpartinputfiletype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contentpartinputvideo.mdx b/docs/components/contentpartinputvideo.mdx index 0d846f378..4443ed305 100644 --- a/docs/components/contentpartinputvideo.mdx +++ b/docs/components/contentpartinputvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputVideo" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `input_video` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `type` | [components.ContentPartInputVideoType](../components/contentpartinputvideotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `input_video` | [components.MultimodalMedia](../components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `type` | [components.ContentPartInputVideoType](../components/contentpartinputvideotype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contentpartvideo.mdx b/docs/components/contentpartvideo.mdx index 058640db3..1b05c01c2 100644 --- a/docs/components/contentpartvideo.mdx +++ b/docs/components/contentpartvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartVideo" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [components.ContentPartVideoType](../components/contentpartvideotype.mdx) | :heavy_check_mark: | N/A | -| `video_url` | [components.VideoURL](../components/videourl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.ContentPartVideoType](../components/contentpartvideotype.mdx) | ✅ | N/A | +| `video_url` | [components.VideoURL](../components/videourl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentredactedthinking.mdx b/docs/components/contentredactedthinking.mdx index 03ca5bcd3..c399abdce 100644 --- a/docs/components/contentredactedthinking.mdx +++ b/docs/components/contentredactedthinking.mdx @@ -6,5 +6,5 @@ title: "ContentRedactedThinking" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesMessageParamTypeRedactedThinking](../components/messagesmessageparamtyperedactedthinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *str* | ✅ | N/A | +| `type` | [components.MessagesMessageParamTypeRedactedThinking](../components/messagesmessageparamtyperedactedthinking.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentservertooluse.mdx b/docs/components/contentservertooluse.mdx index c2377ff20..a95b27f9d 100644 --- a/docs/components/contentservertooluse.mdx +++ b/docs/components/contentservertooluse.mdx @@ -6,8 +6,8 @@ title: "ContentServerToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *str* | :heavy_check_mark: | N/A | | -| `input` | *Optional[Any]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.MessagesMessageParamTypeServerToolUse](../components/messagesmessageparamtypeservertooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *str* | ✅ | N/A | | +| `input` | *Optional[Any]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `type` | [components.MessagesMessageParamTypeServerToolUse](../components/messagesmessageparamtypeservertooluse.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contenttext.mdx b/docs/components/contenttext.mdx index cfdd29eea..a3be2c26a 100644 --- a/docs/components/contenttext.mdx +++ b/docs/components/contenttext.mdx @@ -6,5 +6,5 @@ title: "ContentText" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.FileTypeText](../components/filetypetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *str* | ✅ | N/A | +| `type` | [components.FileTypeText](../components/filetypetext.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentthinking.mdx b/docs/components/contentthinking.mdx index a7921fd6a..37f09585c 100644 --- a/docs/components/contentthinking.mdx +++ b/docs/components/contentthinking.mdx @@ -6,6 +6,6 @@ title: "ContentThinking" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `signature` | *str* | :heavy_check_mark: | N/A | -| `thinking` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesMessageParamTypeThinking](../components/messagesmessageparamtypethinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `signature` | *str* | ✅ | N/A | +| `thinking` | *str* | ✅ | N/A | +| `type` | [components.MessagesMessageParamTypeThinking](../components/messagesmessageparamtypethinking.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contenttoolreference.mdx b/docs/components/contenttoolreference.mdx index bc1e04237..5d5c366eb 100644 --- a/docs/components/contenttoolreference.mdx +++ b/docs/components/contenttoolreference.mdx @@ -6,5 +6,5 @@ title: "ContentToolReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `tool_name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesMessageParamTypeToolReference](../components/messagesmessageparamtypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `tool_name` | *str* | ✅ | N/A | +| `type` | [components.MessagesMessageParamTypeToolReference](../components/messagesmessageparamtypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contenttoolresult.mdx b/docs/components/contenttoolresult.mdx index f83588a9c..e2e7acc45 100644 --- a/docs/components/contenttoolresult.mdx +++ b/docs/components/contenttoolresult.mdx @@ -6,8 +6,8 @@ title: "ContentToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.MessagesMessageParamContentUnion2]](../components/messagesmessageparamcontentunion2.mdx) | :heavy_minus_sign: | N/A | | -| `is_error` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.TypeToolResult](../components/typetoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.MessagesMessageParamContentUnion2]](../components/messagesmessageparamcontentunion2.mdx) | ➖ | N/A | | +| `is_error` | *Optional[bool]* | ➖ | N/A | | +| `tool_use_id` | *str* | ✅ | N/A | | +| `type` | [components.TypeToolResult](../components/typetoolresult.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contenttooluse.mdx b/docs/components/contenttooluse.mdx index fcb072536..bbc977327 100644 --- a/docs/components/contenttooluse.mdx +++ b/docs/components/contenttooluse.mdx @@ -6,8 +6,8 @@ title: "ContentToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *str* | :heavy_check_mark: | N/A | | -| `input` | *Optional[Any]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.MessagesMessageParamTypeToolUse](../components/messagesmessageparamtypetooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | *str* | ✅ | N/A | | +| `input` | *Optional[Any]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `type` | [components.MessagesMessageParamTypeToolUse](../components/messagesmessageparamtypetooluse.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contenttoplogprob.mdx b/docs/components/contenttoplogprob.mdx index 5ac97a3d8..73a010f25 100644 --- a/docs/components/contenttoplogprob.mdx +++ b/docs/components/contenttoplogprob.mdx @@ -6,6 +6,6 @@ title: "ContentTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | ✅ | N/A | +| `logprob` | *float* | ✅ | N/A | +| `token` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contentwebsearchtoolresult.mdx b/docs/components/contentwebsearchtoolresult.mdx index 3f3b1c7fe..a87188438 100644 --- a/docs/components/contentwebsearchtoolresult.mdx +++ b/docs/components/contentwebsearchtoolresult.mdx @@ -6,7 +6,7 @@ title: "ContentWebSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagesmessageparamcontentunion3.mdx) | :heavy_check_mark: | N/A | | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.MessagesMessageParamTypeWebSearchToolResult](../components/messagesmessageparamtypewebsearchtoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagesmessageparamcontentunion3.mdx) | ✅ | N/A | | +| `tool_use_id` | *str* | ✅ | N/A | | +| `type` | [components.MessagesMessageParamTypeWebSearchToolResult](../components/messagesmessageparamtypewebsearchtoolresult.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contentwebsearchtoolresulterror.mdx b/docs/components/contentwebsearchtoolresulterror.mdx index ab974796c..43c06d580 100644 --- a/docs/components/contentwebsearchtoolresulterror.mdx +++ b/docs/components/contentwebsearchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "ContentWebSearchToolResultError" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `error_code` | [components.MessagesMessageParamErrorCode](../components/messagesmessageparamerrorcode.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.MessagesMessageParamTypeWebSearchToolResultError](../components/messagesmessageparamtypewebsearchtoolresulterror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error_code` | [components.MessagesMessageParamErrorCode](../components/messagesmessageparamerrorcode.mdx) | ✅ | N/A | +| `type` | [components.MessagesMessageParamTypeWebSearchToolResultError](../components/messagesmessageparamtypewebsearchtoolresulterror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/contextcompactionitem.mdx b/docs/components/contextcompactionitem.mdx index 369dd320c..e72fa1292 100644 --- a/docs/components/contextcompactionitem.mdx +++ b/docs/components/contextcompactionitem.mdx @@ -9,7 +9,7 @@ A context compaction marker with an optional encrypted summary | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.ContextCompactionItemType](../components/contextcompactionitemtype.mdx) | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file +| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `type` | [components.ContextCompactionItemType](../components/contextcompactionitemtype.mdx) | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file diff --git a/docs/components/contextcompressionplugin.mdx b/docs/components/contextcompressionplugin.mdx index a502a991a..18ea3a4f1 100644 --- a/docs/components/contextcompressionplugin.mdx +++ b/docs/components/contextcompressionplugin.mdx @@ -6,6 +6,6 @@ title: "ContextCompressionPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. | | -| `engine` | [Optional[components.ContextCompressionEngine]](../components/contextcompressionengine.mdx) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | -| `id` | [components.ContextCompressionPluginID](../components/contextcompressionpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `enabled` | *Optional[bool]* | ➖ | Set to false to disable the context-compression plugin for this request. Defaults to true. | | +| `engine` | [Optional[components.ContextCompressionEngine]](../components/contextcompressionengine.mdx) | ➖ | The compression engine to use. Defaults to "middle-out". | middle-out | +| `id` | [components.ContextCompressionPluginID](../components/contextcompressionpluginid.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/contextmanagement.mdx b/docs/components/contextmanagement.mdx index 521afd6c8..650489879 100644 --- a/docs/components/contextmanagement.mdx +++ b/docs/components/contextmanagement.mdx @@ -6,4 +6,4 @@ title: "ContextManagement" | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `edits` | List[[components.Edit](../components/edit.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `edits` | List[[components.Edit](../components/edit.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/contradiction.mdx b/docs/components/contradiction.mdx index df0f53d79..9bcbab36d 100644 --- a/docs/components/contradiction.mdx +++ b/docs/components/contradiction.mdx @@ -6,5 +6,5 @@ title: "Contradiction" | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `stances` | List[[components.Stance](../components/stance.mdx)] | :heavy_check_mark: | N/A | -| `topic` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `stances` | List[[components.Stance](../components/stance.mdx)] | ✅ | N/A | +| `topic` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/costdetails.mdx b/docs/components/costdetails.mdx index eeda364d2..045bea41d 100644 --- a/docs/components/costdetails.mdx +++ b/docs/components/costdetails.mdx @@ -9,7 +9,7 @@ Breakdown of upstream inference costs | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `server_tool_cost` | *OptionalNullable[float]* | :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. | -| `upstream_inference_completions_cost` | *float* | :heavy_check_mark: | N/A | -| `upstream_inference_cost` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `upstream_inference_prompt_cost` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file +| `server_tool_cost` | *OptionalNullable[float]* | ➖ | 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. | +| `upstream_inference_completions_cost` | *float* | ✅ | N/A | +| `upstream_inference_cost` | *OptionalNullable[float]* | ➖ | N/A | +| `upstream_inference_prompt_cost` | *float* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/createbyokkeyrequest.mdx b/docs/components/createbyokkeyrequest.mdx index 360386f6f..649b7eea5 100644 --- a/docs/components/createbyokkeyrequest.mdx +++ b/docs/components/createbyokkeyrequest.mdx @@ -6,16 +6,16 @@ title: "CreateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_api_key_hashes` | List[*str*] | :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"
] | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declared_region` | [OptionalNullable[components.CreateBYOKKeyRequestDeclaredRegion]](../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 | -| `declared_zdr` | *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | -| `is_byok_only` | *Optional[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 | -| `is_fallback` | *Optional[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 | -| `is_required` | *Optional[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` | *str* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [components.BYOKProviderSlug](../components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `workspace_id` | *Optional[str]* | :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 +| `allowed_api_key_hashes` | List[*str*] | ➖ | 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"
] | +| `allowed_models` | List[*str*] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declared_region` | [OptionalNullable[components.CreateBYOKKeyRequestDeclaredRegion]](../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 | +| `declared_zdr` | *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` | *Optional[bool]* | ➖ | Whether this credential should be created in a disabled state. | false | +| `is_byok_only` | *Optional[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 | +| `is_fallback` | *Optional[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 | +| `is_required` | *Optional[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` | *str* | ✅ | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | +| `name` | *OptionalNullable[str]* | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | +| `provider` | [components.BYOKProviderSlug](../components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `workspace_id` | *Optional[str]* | ➖ | 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/components/createbyokkeyresponse.mdx b/docs/components/createbyokkeyresponse.mdx index 4da6fbee6..6ac8473de 100644 --- a/docs/components/createbyokkeyresponse.mdx +++ b/docs/components/createbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "CreateBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.BYOKKey](../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](../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/components/createenduserrequest.mdx b/docs/components/createenduserrequest.mdx index 9d28e4c7e..b81900546 100644 --- a/docs/components/createenduserrequest.mdx +++ b/docs/components/createenduserrequest.mdx @@ -6,4 +6,4 @@ title: "CreateEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | :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` | *str* | ✅ | 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/components/createguardrailrequest.mdx b/docs/components/createguardrailrequest.mdx index fbc52a249..0929d3f1a 100644 --- a/docs/components/createguardrailrequest.mdx +++ b/docs/components/createguardrailrequest.mdx @@ -6,26 +6,26 @@ title: "CreateGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | true | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | -| `allowed_models` | List[*str*] | :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"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../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[str]* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | -| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`enforce_zdr`~~ | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *OptionalNullable[float]* | :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` | *str* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `workspace_id` | *Optional[str]* | :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 +| `allow_safety_retention_google` | *OptionalNullable[bool]* | ➖ | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | true | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | +| `allowed_models` | List[*str*] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | +| `allowed_providers` | List[*str*] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../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[str]* | ➖ | Description of the guardrail | A guardrail for limiting API usage | +| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`enforce_zdr`~~ | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `ignored_models` | List[*str*] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *OptionalNullable[float]* | ➖ | 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` | *str* | ✅ | Name for the new guardrail | My New Guardrail | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `workspace_id` | *Optional[str]* | ➖ | 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/components/createguardrailresponse.mdx b/docs/components/createguardrailresponse.mdx index 63cc820d2..9a5116dff 100644 --- a/docs/components/createguardrailresponse.mdx +++ b/docs/components/createguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "CreateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Guardrail](../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](../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/components/createinternrequest.mdx b/docs/components/createinternrequest.mdx index 28e8aee5c..e85bd9bc3 100644 --- a/docs/components/createinternrequest.mdx +++ b/docs/components/createinternrequest.mdx @@ -9,9 +9,9 @@ Settings for a new intern. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Free-form description, or null. | -| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | Standing instructions the intern boots with, or null. | -| `name` | *str* | :heavy_check_mark: | Intern name, unique per creator within the workspace. | -| `provision` | *Optional[bool]* | :heavy_minus_sign: | Start provisioning during this create operation. Defaults to false. | -| `vault_id` | *Optional[str]* | :heavy_minus_sign: | Vault owned by another intern in this workspace to attach as a borrowed vault. | -| `workspace_id` | *Optional[str]* | :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[str]* | ➖ | Free-form description, or null. | +| `instructions` | *OptionalNullable[str]* | ➖ | Standing instructions the intern boots with, or null. | +| `name` | *str* | ✅ | Intern name, unique per creator within the workspace. | +| `provision` | *Optional[bool]* | ➖ | Start provisioning during this create operation. Defaults to false. | +| `vault_id` | *Optional[str]* | ➖ | Vault owned by another intern in this workspace to attach as a borrowed vault. | +| `workspace_id` | *Optional[str]* | ➖ | 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/components/createobservabilitydestinationrequest.mdx b/docs/components/createobservabilitydestinationrequest.mdx index 1eb1a6577..8ee0ef342 100644 --- a/docs/components/createobservabilitydestinationrequest.mdx +++ b/docs/components/createobservabilitydestinationrequest.mdx @@ -6,17 +6,17 @@ title: "CreateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *Optional[bool]* | :heavy_minus_sign: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *Optional[bool]* | :heavy_minus_sign: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *Optional[bool]* | :heavy_minus_sign: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *Optional[bool]* | :heavy_minus_sign: | When true, include request-context generation metadata. | false | -| `config` | Dict[str, *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../components/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | -| `name` | *str* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegionInput](../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"
] | -| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.CreateObservabilityDestinationRequestType](../components/createobservabilitydestinationrequesttype.mdx) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | -| `workspace_id` | *Optional[str]* | :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 +| `api_key_hashes` | List[*str*] | ➖ | 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 | +| `broadcast_generation_cost` | *Optional[bool]* | ➖ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *Optional[bool]* | ➖ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *Optional[bool]* | ➖ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *Optional[bool]* | ➖ | When true, include request-context generation metadata. | false | +| `config` | Dict[str, *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` | *Optional[bool]* | ➖ | Whether this destination should be enabled immediately. | true | +| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../components/observabilityfilterrulesconfignullable.mdx) | ➖ | Optional structured filter rules controlling which events are forwarded. | null | +| `name` | *str* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *Optional[bool]* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegionInput](../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"
] | +| `sampling_rate` | *Optional[float]* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.CreateObservabilityDestinationRequestType](../components/createobservabilitydestinationrequesttype.mdx) | ✅ | The destination type. Only stable destination types are accepted. | langfuse | +| `workspace_id` | *Optional[str]* | ➖ | 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/components/createobservabilitydestinationresponse.mdx b/docs/components/createobservabilitydestinationresponse.mdx index ed1fe6b03..a631492fa 100644 --- a/docs/components/createobservabilitydestinationresponse.mdx +++ b/docs/components/createobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "CreateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ObservabilityDestination](../components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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](../components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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/components/createpresetfrominferenceresponse.mdx b/docs/components/createpresetfrominferenceresponse.mdx index c31f263d2..8b76124d4 100644 --- a/docs/components/createpresetfrominferenceresponse.mdx +++ b/docs/components/createpresetfrominferenceresponse.mdx @@ -9,4 +9,4 @@ Response containing the created preset with its designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.PresetWithDesignatedVersion](../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](../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/components/createprivateendpointrequest.mdx b/docs/components/createprivateendpointrequest.mdx index 6c0147e3a..8cd673de2 100644 --- a/docs/components/createprivateendpointrequest.mdx +++ b/docs/components/createprivateendpointrequest.mdx @@ -6,11 +6,11 @@ title: "CreatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `activate` | [Optional[components.PrivateEndpointActivation]](../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"
} | -| `base_url` | *Optional[str]* | :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 | -| `declared_region` | [OptionalNullable[components.CreatePrivateEndpointRequestDeclaredRegion]](../components/createprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | -| `declared_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | -| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `pricing` | [Optional[components.PrivateEndpointPricing]](../components/privateendpointpricing.mdx) | :heavy_minus_sign: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `provider_slug` | *str* | :heavy_check_mark: | Slug of the upstream provider. | azure | -| `upstream_model_id` | *str* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `activate` | [Optional[components.PrivateEndpointActivation]](../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"
} | +| `base_url` | *Optional[str]* | ➖ | 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 | +| `declared_region` | [OptionalNullable[components.CreatePrivateEndpointRequestDeclaredRegion]](../components/createprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | +| `declared_zdr` | *OptionalNullable[bool]* | ➖ | Attest that this deployment retains no prompt or completion data. | | +| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `pricing` | [Optional[components.PrivateEndpointPricing]](../components/privateendpointpricing.mdx) | ➖ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `provider_slug` | *str* | ✅ | Slug of the upstream provider. | azure | +| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/components/createprivateendpointvalidationfailedresponsedata.mdx b/docs/components/createprivateendpointvalidationfailedresponsedata.mdx index eff4f07a0..6801e68d6 100644 --- a/docs/components/createprivateendpointvalidationfailedresponsedata.mdx +++ b/docs/components/createprivateendpointvalidationfailedresponsedata.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseData" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `endpoint` | [components.ManagedPrivateEndpoint](../components/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | -| `validation` | [Nullable[components.PrivateEndpointValidationNullable]](../components/privateendpointvalidationnullable.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `endpoint` | [components.ManagedPrivateEndpoint](../components/managedprivateendpoint.mdx) | ✅ | N/A | +| `validation` | [Nullable[components.PrivateEndpointValidationNullable]](../components/privateendpointvalidationnullable.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/createprivateendpointvalidationfailedresponseerror.mdx b/docs/components/createprivateendpointvalidationfailedresponseerror.mdx index 40ca96c87..7175c4302 100644 --- a/docs/components/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/components/createprivateendpointvalidationfailedresponseerror.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/createscimgroupmappingrequest.mdx b/docs/components/createscimgroupmappingrequest.mdx index 5ad1269cb..6264cfcc6 100644 --- a/docs/components/createscimgroupmappingrequest.mdx +++ b/docs/components/createscimgroupmappingrequest.mdx @@ -6,6 +6,6 @@ title: "CreateScimGroupMappingRequest" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `role` | [components.CreateScimGroupMappingRequestRole](../components/createscimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | -| `scim_group_id` | *str* | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `role` | [components.CreateScimGroupMappingRequestRole](../components/createscimgroupmappingrequestrole.mdx) | ✅ | N/A | +| `scim_group_id` | *str* | ✅ | N/A | +| `workspace_id` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/createscimgroupmappingresponse.mdx b/docs/components/createscimgroupmappingresponse.mdx index 9ac0db3fb..72db3ce1a 100644 --- a/docs/components/createscimgroupmappingresponse.mdx +++ b/docs/components/createscimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "CreateScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ScimGroupMapping](../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](../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/components/createscimsyncjobresponse.mdx b/docs/components/createscimsyncjobresponse.mdx index 578411c9c..60f934c6c 100644 --- a/docs/components/createscimsyncjobresponse.mdx +++ b/docs/components/createscimsyncjobresponse.mdx @@ -6,4 +6,4 @@ title: "CreateScimSyncJobResponse" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | [components.ScimSyncJob](../components/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.ScimSyncJob](../components/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/createworkspacerequest.mdx b/docs/components/createworkspacerequest.mdx index 2d5e28682..26c15d610 100644 --- a/docs/components/createworkspacerequest.mdx +++ b/docs/components/createworkspacerequest.mdx @@ -6,15 +6,15 @@ title: "CreateWorkspaceRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the workspace | Production environment workspace | -| `disabled_server_tools` | List[[components.CreateWorkspaceRequestDisabledServerTool](../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"
] | -| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | -| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *str* | :heavy_check_mark: | Name for the new workspace | Production | -| `slug` | *str* | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file +| `default_image_model` | *OptionalNullable[str]* | ➖ | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *OptionalNullable[str]* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *OptionalNullable[str]* | ➖ | Default text model for this workspace | openai/gpt-4o | +| `description` | *OptionalNullable[str]* | ➖ | Description of the workspace | Production environment workspace | +| `disabled_server_tools` | List[[components.CreateWorkspaceRequestDisabledServerTool](../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"
] | +| `io_logging_api_key_ids` | List[*int*] | ➖ | Optional array of API key IDs to filter I/O logging | null | +| `io_logging_sampling_rate` | *Optional[float]* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | +| `is_data_discount_logging_enabled` | *Optional[bool]* | ➖ | Whether data discount logging is enabled | true | +| `is_observability_broadcast_enabled` | *Optional[bool]* | ➖ | Whether broadcast is enabled | false | +| `is_observability_io_logging_enabled` | *Optional[bool]* | ➖ | Whether private logging is enabled | false | +| `name` | *str* | ✅ | Name for the new workspace | Production | +| `slug` | *str* | ✅ | 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/components/createworkspaceresponse.mdx b/docs/components/createworkspaceresponse.mdx index 27d6f40a6..65fb4c548 100644 --- a/docs/components/createworkspaceresponse.mdx +++ b/docs/components/createworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "CreateWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Workspace](../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](../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/components/customtool.mdx b/docs/components/customtool.mdx index 4254b4f61..0912528e3 100644 --- a/docs/components/customtool.mdx +++ b/docs/components/customtool.mdx @@ -9,9 +9,9 @@ Custom tool configuration | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `format_` | [Optional[components.Format]](../components/format_.mdx) | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.CustomToolTypeCustom](../components/customtooltypecustom.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | ➖ | N/A | | +| `description` | *Optional[str]* | ➖ | N/A | | +| `format_` | [Optional[components.Format]](../components/format_.mdx) | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `type` | [components.CustomToolTypeCustom](../components/customtooltypecustom.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/customtoolcallinputdeltaevent.mdx b/docs/components/customtoolcallinputdeltaevent.mdx index 4ff3cab64..8eb38f216 100644 --- a/docs/components/customtoolcallinputdeltaevent.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.CustomToolCallInputDeltaEventType](../components/customtoolcallinputdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.CustomToolCallInputDeltaEventType](../components/customtoolcallinputdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/customtoolcallinputdoneevent.mdx b/docs/components/customtoolcallinputdoneevent.mdx index 9fa94a133..42d962c6b 100644 --- a/docs/components/customtoolcallinputdoneevent.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.CustomToolCallInputDoneEventType](../components/customtoolcallinputdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `input` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.CustomToolCallInputDoneEventType](../components/customtoolcallinputdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/customtoolcallitem.mdx b/docs/components/customtoolcallitem.mdx index c7d8e13ed..1ccbdfe9d 100644 --- a/docs/components/customtoolcallitem.mdx +++ b/docs/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[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 | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `input` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *OptionalNullable[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.CustomToolCallItemType](../components/customtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async_` | *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 | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `input` | *str* | ✅ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `namespace` | *OptionalNullable[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [components.CustomToolCallItemType](../components/customtoolcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/customtoolcalloutputitem.mdx b/docs/components/customtoolcalloutputitem.mdx index 2e8dd6506..aaa13cd33 100644 --- a/docs/components/customtoolcalloutputitem.mdx +++ b/docs/components/customtoolcalloutputitem.mdx @@ -9,7 +9,7 @@ The output from a custom (freeform-grammar) tool call execution. Mirrors `functi | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `output` | [components.CustomToolCallOutputItemOutputUnion2](../components/customtoolcalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | +| `id` | *Optional[str]* | ➖ | N/A | +| `output` | [components.CustomToolCallOutputItemOutputUnion2](../components/customtoolcalloutputitemoutputunion2.mdx) | ✅ | N/A | +| `type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/customtoolcalloutputitemoutputinputimage.mdx b/docs/components/customtoolcalloutputitemoutputinputimage.mdx index 41ee3d26a..b9ec1f0df 100644 --- a/docs/components/customtoolcalloutputitemoutputinputimage.mdx +++ b/docs/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](../components/customtoolcalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | -| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.CustomToolCallOutputItemOutputType](../components/customtoolcalloutputitemoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [components.CustomToolCallOutputItemDetail](../components/customtoolcalloutputitemdetail.mdx) | ✅ | N/A | +| `file_id` | *OptionalNullable[str]* | ➖ | N/A | +| `image_url` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.CustomToolCallOutputItemOutputType](../components/customtoolcalloutputitemoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/dabenchmarkentry.mdx b/docs/components/dabenchmarkentry.mdx index 63238a9c4..c24022b0e 100644 --- a/docs/components/dabenchmarkentry.mdx +++ b/docs/components/dabenchmarkentry.mdx @@ -9,8 +9,8 @@ A single Design Arena benchmark entry for a specific arena+category | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `arena` | *str* | :heavy_check_mark: | Arena type (e.g. models, builders, agents) | models | -| `category` | *str* | :heavy_check_mark: | Category within the arena (e.g. website, gamedev, uicomponent) | website | -| `elo` | *float* | :heavy_check_mark: | ELO rating from head-to-head arena battles | 1385.2 | -| `rank` | *int* | :heavy_check_mark: | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | -| `win_rate` | *float* | :heavy_check_mark: | Win rate percentage in arena battles | 62.5 | \ No newline at end of file +| `arena` | *str* | ✅ | Arena type (e.g. models, builders, agents) | models | +| `category` | *str* | ✅ | Category within the arena (e.g. website, gamedev, uicomponent) | website | +| `elo` | *float* | ✅ | ELO rating from head-to-head arena battles | 1385.2 | +| `rank` | *int* | ✅ | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | +| `win_rate` | *float* | ✅ | Win rate percentage in arena battles | 62.5 | \ No newline at end of file diff --git a/docs/components/datetimeservertool.mdx b/docs/components/datetimeservertool.mdx index af483becf..c70b0aca8 100644 --- a/docs/components/datetimeservertool.mdx +++ b/docs/components/datetimeservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: returns the current date and time | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `parameters` | [Optional[components.DatetimeServerToolConfig]](../components/datetimeservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | -| `type` | [components.DatetimeServerToolType](../components/datetimeservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.DatetimeServerToolConfig]](../components/datetimeservertoolconfig.mdx) | ➖ | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | +| `type` | [components.DatetimeServerToolType](../components/datetimeservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/datetimeservertoolconfig.mdx b/docs/components/datetimeservertoolconfig.mdx index f2c289a39..1fcc9a9bc 100644 --- a/docs/components/datetimeservertoolconfig.mdx +++ b/docs/components/datetimeservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:datetime server tool | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `timezone` | *Optional[str]* | :heavy_minus_sign: | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file +| `timezone` | *Optional[str]* | ➖ | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file diff --git a/docs/components/debugevent.mdx b/docs/components/debugevent.mdx index fb80bd742..7e50b0633 100644 --- a/docs/components/debugevent.mdx +++ b/docs/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](../components/debugeventdebug.mdx) | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.DebugEventType](../components/debugeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `debug` | [components.DebugEventDebug](../components/debugeventdebug.mdx) | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.DebugEventType](../components/debugeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/debugeventdebug.mdx b/docs/components/debugeventdebug.mdx index feaaf1f4a..112cf01ed 100644 --- a/docs/components/debugeventdebug.mdx +++ b/docs/components/debugeventdebug.mdx @@ -6,5 +6,5 @@ title: "DebugEventDebug" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `echo_upstream_body` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `timings` | [Optional[components.DebugEventTimings]](../components/debugeventtimings.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `echo_upstream_body` | Dict[str, *Any*] | ➖ | N/A | +| `timings` | [Optional[components.DebugEventTimings]](../components/debugeventtimings.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/debugeventtimings.mdx b/docs/components/debugeventtimings.mdx index 0d5b176d7..4c22c0fa7 100644 --- a/docs/components/debugeventtimings.mdx +++ b/docs/components/debugeventtimings.mdx @@ -6,6 +6,6 @@ title: "DebugEventTimings" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `epoch_ms` | *int* | :heavy_check_mark: | N/A | -| `event` | [components.DebugEventEvent](../components/debugeventevent.mdx) | :heavy_check_mark: | N/A | -| `start_ms` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `epoch_ms` | *int* | ✅ | N/A | +| `event` | [components.DebugEventEvent](../components/debugeventevent.mdx) | ✅ | N/A | +| `start_ms` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/decisions.mdx b/docs/components/decisions.mdx index d68a93a6e..2e96f6e1f 100644 --- a/docs/components/decisions.mdx +++ b/docs/components/decisions.mdx @@ -6,6 +6,6 @@ title: "Decisions" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../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` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/decisionschoiceanswer.mdx b/docs/components/decisionschoiceanswer.mdx index a27de14af..af8877b4a 100644 --- a/docs/components/decisionschoiceanswer.mdx +++ b/docs/components/decisionschoiceanswer.mdx @@ -6,7 +6,7 @@ title: "DecisionsChoiceAnswer" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `choice` | *str* | :heavy_check_mark: | N/A | -| `confidence` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `probabilities` | Dict[str, *float*] | :heavy_minus_sign: | N/A | -| `type` | [components.DecisionsChoiceAnswerType](../components/decisionschoiceanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `choice` | *str* | ✅ | N/A | +| `confidence` | *Optional[float]* | ➖ | N/A | +| `probabilities` | Dict[str, *float*] | ➖ | N/A | +| `type` | [components.DecisionsChoiceAnswerType](../components/decisionschoiceanswertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/decisionschoicequestion.mdx b/docs/components/decisionschoicequestion.mdx index dfd098de0..ccc63b726 100644 --- a/docs/components/decisionschoicequestion.mdx +++ b/docs/components/decisionschoicequestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsChoiceQuestion" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `criteria` | Dict[str, [Nullable[components.Criteria]](../components/criteria.mdx)] | :heavy_check_mark: | N/A | -| `instructions` | [components.DecisionsChoiceQuestionInstructions](../components/decisionschoicequestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `type` | [components.DecisionsChoiceQuestionType](../components/decisionschoicequestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `criteria` | Dict[str, [Nullable[components.Criteria]](../components/criteria.mdx)] | ✅ | N/A | +| `instructions` | [components.DecisionsChoiceQuestionInstructions](../components/decisionschoicequestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `type` | [components.DecisionsChoiceQuestionType](../components/decisionschoicequestiontype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/decisionsnoulanswer.mdx b/docs/components/decisionsnoulanswer.mdx index d34f71c34..c4759c7d0 100644 --- a/docs/components/decisionsnoulanswer.mdx +++ b/docs/components/decisionsnoulanswer.mdx @@ -6,5 +6,5 @@ title: "DecisionsNoulAnswer" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `noul` | *float* | :heavy_check_mark: | N/A | -| `type` | [components.DecisionsNoulAnswerType](../components/decisionsnoulanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `noul` | *float* | ✅ | N/A | +| `type` | [components.DecisionsNoulAnswerType](../components/decisionsnoulanswertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/decisionsnoulquestion.mdx b/docs/components/decisionsnoulquestion.mdx index bd0cd40b9..daba55872 100644 --- a/docs/components/decisionsnoulquestion.mdx +++ b/docs/components/decisionsnoulquestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsNoulQuestion" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `criteria` | [Optional[components.DecisionsNoulQuestionCriteria]](../components/decisionsnoulquestioncriteria.mdx) | :heavy_minus_sign: | N/A | -| `instructions` | [components.DecisionsNoulQuestionInstructions](../components/decisionsnoulquestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `type` | [components.DecisionsNoulQuestionType](../components/decisionsnoulquestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `criteria` | [Optional[components.DecisionsNoulQuestionCriteria]](../components/decisionsnoulquestioncriteria.mdx) | ➖ | N/A | +| `instructions` | [components.DecisionsNoulQuestionInstructions](../components/decisionsnoulquestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `type` | [components.DecisionsNoulQuestionType](../components/decisionsnoulquestiontype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/decisionsnoulquestioncriteria.mdx b/docs/components/decisionsnoulquestioncriteria.mdx index eafa2e834..a318be63c 100644 --- a/docs/components/decisionsnoulquestioncriteria.mdx +++ b/docs/components/decisionsnoulquestioncriteria.mdx @@ -6,5 +6,5 @@ title: "DecisionsNoulQuestionCriteria" | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `false` | [components.FalseT](../components/falset.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `true` | [components.TrueT](../components/truet.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | \ No newline at end of file +| `false` | [components.FalseT](../components/falset.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `true` | [components.TrueT](../components/truet.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | \ No newline at end of file diff --git a/docs/components/decisionsrequest.mdx b/docs/components/decisionsrequest.mdx index a5f5e91cd..e84d801a9 100644 --- a/docs/components/decisionsrequest.mdx +++ b/docs/components/decisionsrequest.mdx @@ -6,10 +6,10 @@ title: "DecisionsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `questions` | Dict[str, [components.Questions](../components/questions.mdx)] | :heavy_check_mark: | N/A | | -| `session_id` | *Optional[str]* | :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](../components/state.mdx) | :heavy_check_mark: | The content to evaluate: a plain string, or a JSON object or array of related context. | | -| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `model` | *str* | ✅ | N/A | | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `questions` | Dict[str, [components.Questions](../components/questions.mdx)] | ✅ | N/A | | +| `session_id` | *Optional[str]* | ➖ | 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](../components/state.mdx) | ✅ | The content to evaluate: a plain string, or a JSON object or array of related context. | | +| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/decisionsresponse.mdx b/docs/components/decisionsresponse.mdx index cdd215386..baadcef52 100644 --- a/docs/components/decisionsresponse.mdx +++ b/docs/components/decisionsresponse.mdx @@ -6,8 +6,8 @@ title: "DecisionsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `answers` | Dict[str, [components.Answers](../components/answers.mdx)] | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `provider` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `usage` | [components.DecisionsResponseUsage](../components/decisionsresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `answers` | Dict[str, [components.Answers](../components/answers.mdx)] | ✅ | N/A | +| `id` | *Optional[str]* | ➖ | N/A | +| `model` | *str* | ✅ | N/A | +| `provider` | *Optional[str]* | ➖ | N/A | +| `usage` | [components.DecisionsResponseUsage](../components/decisionsresponseusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/decisionsresponseusage.mdx b/docs/components/decisionsresponseusage.mdx index d89f6e717..ee6edf055 100644 --- a/docs/components/decisionsresponseusage.mdx +++ b/docs/components/decisionsresponseusage.mdx @@ -6,6 +6,6 @@ title: "DecisionsResponseUsage" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `cost` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `input_tokens` | *int* | :heavy_check_mark: | N/A | -| `output_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `cost` | *Optional[float]* | ➖ | N/A | +| `input_tokens` | *int* | ✅ | N/A | +| `output_tokens` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/decisionsscoreanswer.mdx b/docs/components/decisionsscoreanswer.mdx index 4bc4bdee2..31c57e29d 100644 --- a/docs/components/decisionsscoreanswer.mdx +++ b/docs/components/decisionsscoreanswer.mdx @@ -6,8 +6,8 @@ title: "DecisionsScoreAnswer" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `confidence` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `legend` | Dict[str, [components.Legend](../components/legend.mdx)] | :heavy_minus_sign: | N/A | -| `probabilities` | Dict[str, *float*] | :heavy_minus_sign: | N/A | -| `score` | *float* | :heavy_check_mark: | N/A | -| `type` | [components.DecisionsScoreAnswerType](../components/decisionsscoreanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `confidence` | *Optional[float]* | ➖ | N/A | +| `legend` | Dict[str, [components.Legend](../components/legend.mdx)] | ➖ | N/A | +| `probabilities` | Dict[str, *float*] | ➖ | N/A | +| `score` | *float* | ✅ | N/A | +| `type` | [components.DecisionsScoreAnswerType](../components/decisionsscoreanswertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/decisionsscorequestion.mdx b/docs/components/decisionsscorequestion.mdx index c261757bc..6568adb52 100644 --- a/docs/components/decisionsscorequestion.mdx +++ b/docs/components/decisionsscorequestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsScoreQuestion" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `criteria` | List[[components.Criterion](../components/criterion.mdx)] | :heavy_check_mark: | N/A | -| `instructions` | [components.DecisionsScoreQuestionInstructions](../components/decisionsscorequestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `type` | [components.DecisionsScoreQuestionType](../components/decisionsscorequestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `criteria` | List[[components.Criterion](../components/criterion.mdx)] | ✅ | N/A | +| `instructions` | [components.DecisionsScoreQuestionInstructions](../components/decisionsscorequestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `type` | [components.DecisionsScoreQuestionType](../components/decisionsscorequestiontype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/defaultparameters.mdx b/docs/components/defaultparameters.mdx index 6c502ac4c..78c74a24e 100644 --- a/docs/components/defaultparameters.mdx +++ b/docs/components/defaultparameters.mdx @@ -9,9 +9,9 @@ Default parameters for this model | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `repetition_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `top_k` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | +| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | +| `repetition_penalty` | *OptionalNullable[float]* | ➖ | N/A | +| `temperature` | *OptionalNullable[float]* | ➖ | N/A | +| `top_k` | *OptionalNullable[int]* | ➖ | N/A | +| `top_p` | *OptionalNullable[float]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/deferredbm25search.mdx b/docs/components/deferredbm25search.mdx index 6cc32f8b5..191d4ae75 100644 --- a/docs/components/deferredbm25search.mdx +++ b/docs/components/deferredbm25search.mdx @@ -9,5 +9,5 @@ Deterministic BM25 retrieval over supplied tool definitions. | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `type` | [components.DeferredBm25SearchType](../components/deferredbm25searchtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `max_results` | *Optional[int]* | ➖ | N/A | +| `type` | [components.DeferredBm25SearchType](../components/deferredbm25searchtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/deferredcustomsearch.mdx b/docs/components/deferredcustomsearch.mdx index eeac494ae..e74d5af88 100644 --- a/docs/components/deferredcustomsearch.mdx +++ b/docs/components/deferredcustomsearch.mdx @@ -9,7 +9,7 @@ Caller-executed search returning existing tool identities under result_key. | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `result_key` | *str* | :heavy_check_mark: | N/A | -| `tool_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.DeferredCustomSearchType](../components/deferredcustomsearchtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `max_results` | *Optional[int]* | ➖ | N/A | +| `result_key` | *str* | ✅ | N/A | +| `tool_id` | *str* | ✅ | N/A | +| `type` | [components.DeferredCustomSearchType](../components/deferredcustomsearchtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/deferredregexsearch.mdx b/docs/components/deferredregexsearch.mdx index 0687fb6b5..7ababe0f7 100644 --- a/docs/components/deferredregexsearch.mdx +++ b/docs/components/deferredregexsearch.mdx @@ -9,5 +9,5 @@ Versioned safe-regex retrieval over supplied tool definitions. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `type` | [components.DeferredRegexSearchType](../components/deferredregexsearchtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `max_results` | *Optional[int]* | ➖ | N/A | +| `type` | [components.DeferredRegexSearchType](../components/deferredregexsearchtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/deferredtoolscontrol.mdx b/docs/components/deferredtoolscontrol.mdx index c49a0ba01..29aa1a5c1 100644 --- a/docs/components/deferredtoolscontrol.mdx +++ b/docs/components/deferredtoolscontrol.mdx @@ -9,7 +9,7 @@ Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `profile` | [components.Profile](../components/profile.mdx) | :heavy_check_mark: | Loading profile. Only `portable` is available in this release: OpenRouter serves deferral with router-built search and call wrappers on any model. | | -| `protocol` | [components.Protocol](../components/protocol.mdx) | :heavy_check_mark: | N/A | | -| `search` | [components.DeferredToolsSearchStrategy](../components/deferredtoolssearchstrategy.mdx) | :heavy_check_mark: | Router-local regex/BM25 or caller-owned custom search. | \{
"max_results": 5,
"type": "bm25"
} | -| `validation` | [components.Validation](../components/validation.mdx) | :heavy_check_mark: | Where tool-call arguments are checked against the original schema. Only `runtime` (in OpenRouter) is available in this release. | | \ No newline at end of file +| `profile` | [components.Profile](../components/profile.mdx) | ✅ | Loading profile. Only `portable` is available in this release: OpenRouter serves deferral with router-built search and call wrappers on any model. | | +| `protocol` | [components.Protocol](../components/protocol.mdx) | ✅ | N/A | | +| `search` | [components.DeferredToolsSearchStrategy](../components/deferredtoolssearchstrategy.mdx) | ✅ | Router-local regex/BM25 or caller-owned custom search. | \{
"max_results": 5,
"type": "bm25"
} | +| `validation` | [components.Validation](../components/validation.mdx) | ✅ | Where tool-call arguments are checked against the original schema. Only `runtime` (in OpenRouter) is available in this release. | | \ No newline at end of file diff --git a/docs/components/deletebyokkeyresponse.mdx b/docs/components/deletebyokkeyresponse.mdx index f1c80d265..f2372798a 100644 --- a/docs/components/deletebyokkeyresponse.mdx +++ b/docs/components/deletebyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file +| `deleted` | *Literal[True]* | ✅ | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file diff --git a/docs/components/deleteguardrailresponse.mdx b/docs/components/deleteguardrailresponse.mdx index 36069a963..12db72407 100644 --- a/docs/components/deleteguardrailresponse.mdx +++ b/docs/components/deleteguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteGuardrailResponse" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file +| `deleted` | *Literal[True]* | ✅ | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/docs/components/deleteinternrequest.mdx b/docs/components/deleteinternrequest.mdx index 3b870d4dd..8323d82fd 100644 --- a/docs/components/deleteinternrequest.mdx +++ b/docs/components/deleteinternrequest.mdx @@ -9,4 +9,4 @@ Optional consent for a teardown that discards the workspace. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `acknowledge_workspace_loss` | *Optional[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 +| `acknowledge_workspace_loss` | *Optional[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/components/deleteinternresponse.mdx b/docs/components/deleteinternresponse.mdx index dcf556fcd..c24e52427 100644 --- a/docs/components/deleteinternresponse.mdx +++ b/docs/components/deleteinternresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `deleting` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `deleting` | *Literal[True]* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/deleteobservabilitydestinationresponse.mdx b/docs/components/deleteobservabilitydestinationresponse.mdx index 4d572b688..8660679b1 100644 --- a/docs/components/deleteobservabilitydestinationresponse.mdx +++ b/docs/components/deleteobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteObservabilityDestinationResponse" | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Always `true` on success. | \ No newline at end of file +| `deleted` | *Literal[True]* | ✅ | Always `true` on success. | \ No newline at end of file diff --git a/docs/components/deleteprivateendpointresponse.mdx b/docs/components/deleteprivateendpointresponse.mdx index d4e2b8816..039a2200f 100644 --- a/docs/components/deleteprivateendpointresponse.mdx +++ b/docs/components/deleteprivateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "DeletePrivateEndpointResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | [components.DeletePrivateEndpointResponseData](../components/deleteprivateendpointresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.DeletePrivateEndpointResponseData](../components/deleteprivateendpointresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/deleteprivateendpointresponsedata.mdx b/docs/components/deleteprivateendpointresponsedata.mdx index bdef67898..83b946878 100644 --- a/docs/components/deleteprivateendpointresponsedata.mdx +++ b/docs/components/deleteprivateendpointresponsedata.mdx @@ -6,4 +6,4 @@ title: "DeletePrivateEndpointResponseData" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/components/deletescimgroupmappingresponse.mdx b/docs/components/deletescimgroupmappingresponse.mdx index 1ed4e164a..593f90002 100644 --- a/docs/components/deletescimgroupmappingresponse.mdx +++ b/docs/components/deletescimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteScimGroupMappingResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `deleted` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `deleted` | *Literal[True]* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/deleteworkspacebudgetresponse.mdx b/docs/components/deleteworkspacebudgetresponse.mdx index fb5ff101e..35ef08759 100644 --- a/docs/components/deleteworkspacebudgetresponse.mdx +++ b/docs/components/deleteworkspacebudgetresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file +| `deleted` | *Literal[True]* | ✅ | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file diff --git a/docs/components/deleteworkspaceresponse.mdx b/docs/components/deleteworkspaceresponse.mdx index 93b4da474..d5a14f3ab 100644 --- a/docs/components/deleteworkspaceresponse.mdx +++ b/docs/components/deleteworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteWorkspaceResponse" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the workspace was deleted | true | \ No newline at end of file +| `deleted` | *Literal[True]* | ✅ | Confirmation that the workspace was deleted | true | \ No newline at end of file diff --git a/docs/components/easyinputmessage.mdx b/docs/components/easyinputmessage.mdx index 60e935b6d..baadd1cbd 100644 --- a/docs/components/easyinputmessage.mdx +++ b/docs/components/easyinputmessage.mdx @@ -6,7 +6,7 @@ title: "EasyInputMessage" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [OptionalNullable[components.EasyInputMessageContentUnion2]](../components/easyinputmessagecontentunion2.mdx) | :heavy_minus_sign: | N/A | | -| `phase` | [OptionalNullable[components.EasyInputMessagePhaseUnion]](../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](../components/easyinputmessageroleunion.mdx) | :heavy_check_mark: | N/A | | -| `type` | [Optional[components.EasyInputMessageTypeMessage]](../components/easyinputmessagetypemessage.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `content` | [OptionalNullable[components.EasyInputMessageContentUnion2]](../components/easyinputmessagecontentunion2.mdx) | ➖ | N/A | | +| `phase` | [OptionalNullable[components.EasyInputMessagePhaseUnion]](../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](../components/easyinputmessageroleunion.mdx) | ✅ | N/A | | +| `type` | [Optional[components.EasyInputMessageTypeMessage]](../components/easyinputmessagetypemessage.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/easyinputmessagecontentinputimage.mdx b/docs/components/easyinputmessagecontentinputimage.mdx index d67f17f84..fc482ec28 100644 --- a/docs/components/easyinputmessagecontentinputimage.mdx +++ b/docs/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](../components/easyinputmessagedetail.mdx) | :heavy_check_mark: | N/A | -| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.EasyInputMessageTypeInputImage](../components/easyinputmessagetypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [components.EasyInputMessageDetail](../components/easyinputmessagedetail.mdx) | ✅ | N/A | +| `file_id` | *OptionalNullable[str]* | ➖ | N/A | +| `image_url` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.EasyInputMessageTypeInputImage](../components/easyinputmessagetypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/edgenetworktimeoutresponseerrordata.mdx b/docs/components/edgenetworktimeoutresponseerrordata.mdx index e0fedd8b5..a0f6caf35 100644 --- a/docs/components/edgenetworktimeoutresponseerrordata.mdx +++ b/docs/components/edgenetworktimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for EdgeNetworkTimeoutResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/editclearthinking20251015.mdx b/docs/components/editclearthinking20251015.mdx index 0796f7cdb..aa3ec8f3c 100644 --- a/docs/components/editclearthinking20251015.mdx +++ b/docs/components/editclearthinking20251015.mdx @@ -6,5 +6,5 @@ title: "EditClearThinking20251015" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `keep` | [Optional[components.Keep]](../components/keep.mdx) | :heavy_minus_sign: | N/A | -| `type` | [components.TypeClearThinking20251015](../components/typeclearthinking20251015.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `keep` | [Optional[components.Keep]](../components/keep.mdx) | ➖ | N/A | +| `type` | [components.TypeClearThinking20251015](../components/typeclearthinking20251015.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/editcleartooluses20250919.mdx b/docs/components/editcleartooluses20250919.mdx index a8a31837f..50fc0a873 100644 --- a/docs/components/editcleartooluses20250919.mdx +++ b/docs/components/editcleartooluses20250919.mdx @@ -6,9 +6,9 @@ title: "EditClearToolUses20250919" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `clear_at_least` | [OptionalNullable[components.AnthropicInputTokensClearAtLeast]](../components/anthropicinputtokensclearatleast.mdx) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 50000
} | -| `clear_tool_inputs` | [OptionalNullable[components.ClearToolInputs]](../components/cleartoolinputs.mdx) | :heavy_minus_sign: | N/A | | -| `exclude_tools` | List[*str*] | :heavy_minus_sign: | N/A | | -| `keep` | [Optional[components.AnthropicToolUsesKeep]](../components/anthropictooluseskeep.mdx) | :heavy_minus_sign: | N/A | \{
"type": "tool_uses",
"value": 5
} | -| `trigger` | [Optional[components.Trigger]](../components/trigger.mdx) | :heavy_minus_sign: | N/A | | -| `type` | [components.TypeClearToolUses20250919](../components/typecleartooluses20250919.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `clear_at_least` | [OptionalNullable[components.AnthropicInputTokensClearAtLeast]](../components/anthropicinputtokensclearatleast.mdx) | ➖ | N/A | \{
"type": "input_tokens",
"value": 50000
} | +| `clear_tool_inputs` | [OptionalNullable[components.ClearToolInputs]](../components/cleartoolinputs.mdx) | ➖ | N/A | | +| `exclude_tools` | List[*str*] | ➖ | N/A | | +| `keep` | [Optional[components.AnthropicToolUsesKeep]](../components/anthropictooluseskeep.mdx) | ➖ | N/A | \{
"type": "tool_uses",
"value": 5
} | +| `trigger` | [Optional[components.Trigger]](../components/trigger.mdx) | ➖ | N/A | | +| `type` | [components.TypeClearToolUses20250919](../components/typecleartooluses20250919.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/editcompact20260112.mdx b/docs/components/editcompact20260112.mdx index 09c8fd6f6..15ea940b3 100644 --- a/docs/components/editcompact20260112.mdx +++ b/docs/components/editcompact20260112.mdx @@ -6,7 +6,7 @@ title: "EditCompact20260112" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `pause_after_compaction` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `trigger` | [OptionalNullable[components.TriggerInputTokens]](../components/triggerinputtokens.mdx) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 100000
} | -| `type` | [components.TypeCompact20260112](../components/typecompact20260112.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `instructions` | *OptionalNullable[str]* | ➖ | N/A | | +| `pause_after_compaction` | *Optional[bool]* | ➖ | N/A | | +| `trigger` | [OptionalNullable[components.TriggerInputTokens]](../components/triggerinputtokens.mdx) | ➖ | N/A | \{
"type": "input_tokens",
"value": 100000
} | +| `type` | [components.TypeCompact20260112](../components/typecompact20260112.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/embeddings.mdx b/docs/components/embeddings.mdx index dafa20864..4b945e4db 100644 --- a/docs/components/embeddings.mdx +++ b/docs/components/embeddings.mdx @@ -6,6 +6,6 @@ title: "Embeddings" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../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` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/endpointinfo.mdx b/docs/components/endpointinfo.mdx index e525afd1a..8527695fb 100644 --- a/docs/components/endpointinfo.mdx +++ b/docs/components/endpointinfo.mdx @@ -6,6 +6,6 @@ title: "EndpointInfo" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | :heavy_check_mark: | N/A | -| `provider` | *str* | :heavy_check_mark: | N/A | -| `selected` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file +| `model` | *str* | ✅ | N/A | +| `provider` | *str* | ✅ | N/A | +| `selected` | *bool* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/endpointsmetadata.mdx b/docs/components/endpointsmetadata.mdx index 4add6ebfc..a70410e56 100644 --- a/docs/components/endpointsmetadata.mdx +++ b/docs/components/endpointsmetadata.mdx @@ -6,5 +6,5 @@ title: "EndpointsMetadata" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `available` | List[[components.EndpointInfo](../components/endpointinfo.mdx)] | :heavy_check_mark: | N/A | -| `total` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `available` | List[[components.EndpointInfo](../components/endpointinfo.mdx)] | ✅ | N/A | +| `total` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/enduser.mdx b/docs/components/enduser.mdx index 27621b0e6..0a7c59d64 100644 --- a/docs/components/enduser.mdx +++ b/docs/components/enduser.mdx @@ -6,7 +6,7 @@ title: "EndUser" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Registration creation time. | 2026-09-16T12:00:00Z | -| `is_active` | *bool* | :heavy_check_mark: | Whether this registration is active. Not an inference authorization decision. | true | -| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | -| `user` | *str* | :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 +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | Registration creation time. | 2026-09-16T12:00:00Z | +| `is_active` | *bool* | ✅ | Whether this registration is active. Not an inference authorization decision. | true | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | +| `user` | *str* | ✅ | 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/components/enduserresponse.mdx b/docs/components/enduserresponse.mdx index 4b605db12..027565ed6 100644 --- a/docs/components/enduserresponse.mdx +++ b/docs/components/enduserresponse.mdx @@ -6,4 +6,4 @@ title: "EndUserResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.EndUser](../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](../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/components/enumcapability.mdx b/docs/components/enumcapability.mdx index 4c04e707a..1aa68f8cf 100644 --- a/docs/components/enumcapability.mdx +++ b/docs/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](../components/enumcapabilitytype.mdx) | :heavy_check_mark: | N/A | -| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.EnumCapabilityType](../components/enumcapabilitytype.mdx) | ✅ | N/A | +| `values` | List[*str*] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/errorevent.mdx b/docs/components/errorevent.mdx index b09b8411e..97c8cbced 100644 --- a/docs/components/errorevent.mdx +++ b/docs/components/errorevent.mdx @@ -9,8 +9,8 @@ Event emitted when an error occurs during streaming | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `code` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `param` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ErrorEventType](../components/erroreventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *Nullable[str]* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `param` | *Nullable[str]* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ErrorEventType](../components/erroreventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/failedmodel.mdx b/docs/components/failedmodel.mdx index 70d6de50d..cde817d52 100644 --- a/docs/components/failedmodel.mdx +++ b/docs/components/failedmodel.mdx @@ -6,6 +6,6 @@ title: "FailedModel" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `error` | *str* | :heavy_check_mark: | Error message describing why the model failed. | -| `model` | *str* | :heavy_check_mark: | Slug of the analysis model that failed. | -| `status_code` | *Optional[int]* | :heavy_minus_sign: | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file +| `error` | *str* | ✅ | Error message describing why the model failed. | +| `model` | *str* | ✅ | Slug of the analysis model that failed. | +| `status_code` | *Optional[int]* | ➖ | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file diff --git a/docs/components/filecitation.mdx b/docs/components/filecitation.mdx index 79ca74388..c0d119341 100644 --- a/docs/components/filecitation.mdx +++ b/docs/components/filecitation.mdx @@ -6,7 +6,7 @@ title: "FileCitation" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FileCitationType](../components/filecitationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file_id` | *str* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `index` | *int* | ✅ | N/A | +| `type` | [components.FileCitationType](../components/filecitationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fileparserplugin.mdx b/docs/components/fileparserplugin.mdx index 2a74948b2..d4d529094 100644 --- a/docs/components/fileparserplugin.mdx +++ b/docs/components/fileparserplugin.mdx @@ -6,6 +6,6 @@ title: "FileParserPlugin" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | | -| `id` | [components.FileParserPluginID](../components/fileparserpluginid.mdx) | :heavy_check_mark: | N/A | | -| `pdf` | [Optional[components.PDFParserOptions]](../components/pdfparseroptions.mdx) | :heavy_minus_sign: | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file +| `enabled` | *Optional[bool]* | ➖ | Set to false to disable the file-parser plugin for this request. Defaults to true. | | +| `id` | [components.FileParserPluginID](../components/fileparserpluginid.mdx) | ✅ | N/A | | +| `pdf` | [Optional[components.PDFParserOptions]](../components/pdfparseroptions.mdx) | ➖ | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file diff --git a/docs/components/filepath.mdx b/docs/components/filepath.mdx index f6d81e7b4..2cdf20979 100644 --- a/docs/components/filepath.mdx +++ b/docs/components/filepath.mdx @@ -6,6 +6,6 @@ title: "FilePath" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FilePathType](../components/filepathtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file_id` | *str* | ✅ | N/A | +| `index` | *int* | ✅ | N/A | +| `type` | [components.FilePathType](../components/filepathtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/filesearchservertool.mdx b/docs/components/filesearchservertool.mdx index 573425f38..d1b6b622c 100644 --- a/docs/components/filesearchservertool.mdx +++ b/docs/components/filesearchservertool.mdx @@ -9,8 +9,8 @@ File search tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `filters` | [OptionalNullable[components.FiltersUnion]](../components/filtersunion.mdx) | :heavy_minus_sign: | N/A | -| `max_num_results` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `ranking_options` | [Optional[components.RankingOptions]](../components/rankingoptions.mdx) | :heavy_minus_sign: | N/A | -| `type` | [components.TypeFileSearch](../components/typefilesearch.mdx) | :heavy_check_mark: | N/A | -| `vector_store_ids` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filters` | [OptionalNullable[components.FiltersUnion]](../components/filtersunion.mdx) | ➖ | N/A | +| `max_num_results` | *Optional[int]* | ➖ | N/A | +| `ranking_options` | [Optional[components.RankingOptions]](../components/rankingoptions.mdx) | ➖ | N/A | +| `type` | [components.TypeFileSearch](../components/typefilesearch.mdx) | ✅ | N/A | +| `vector_store_ids` | List[*str*] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/filesservertool.mdx b/docs/components/filesservertool.mdx index d9cc0a84d..7c4b21c01 100644 --- a/docs/components/filesservertool.mdx +++ b/docs/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` | [Optional[components.FilesServerToolConfig]](../components/filesservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:files server tool | \{} | -| `type` | [components.FilesServerToolType](../components/filesservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.FilesServerToolConfig]](../components/filesservertoolconfig.mdx) | ➖ | Configuration for the openrouter:files server tool | \{} | +| `type` | [components.FilesServerToolType](../components/filesservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/filters.mdx b/docs/components/filters.mdx index deb052770..8620174c3 100644 --- a/docs/components/filters.mdx +++ b/docs/components/filters.mdx @@ -6,6 +6,6 @@ title: "Filters" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `key` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.FiltersType](../components/filterstype.mdx) | :heavy_check_mark: | N/A | -| `value` | [components.FileSearchServerToolValue2](../components/filesearchservertoolvalue2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `key` | *str* | ✅ | N/A | +| `type` | [components.FiltersType](../components/filterstype.mdx) | ✅ | N/A | +| `value` | [components.FileSearchServerToolValue2](../components/filesearchservertoolvalue2.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/forbiddenresponseerrordata.mdx b/docs/components/forbiddenresponseerrordata.mdx index cdc5cd4c3..2f07b6e1d 100644 --- a/docs/components/forbiddenresponseerrordata.mdx +++ b/docs/components/forbiddenresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ForbiddenResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/formatgrammar.mdx b/docs/components/formatgrammar.mdx index 27fb6f5f6..6a72260c4 100644 --- a/docs/components/formatgrammar.mdx +++ b/docs/components/formatgrammar.mdx @@ -6,6 +6,6 @@ title: "FormatGrammar" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `definition` | *str* | :heavy_check_mark: | N/A | -| `syntax` | [components.Syntax](../components/syntax.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.FormatTypeGrammar](../components/formattypegrammar.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `definition` | *str* | ✅ | N/A | +| `syntax` | [components.Syntax](../components/syntax.mdx) | ✅ | N/A | +| `type` | [components.FormatTypeGrammar](../components/formattypegrammar.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/formatjsonobjectconfig.mdx b/docs/components/formatjsonobjectconfig.mdx index 376faaf43..6574b722b 100644 --- a/docs/components/formatjsonobjectconfig.mdx +++ b/docs/components/formatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.FormatJSONObjectConfigType](../components/formatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.FormatJSONObjectConfigType](../components/formatjsonobjectconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/formatjsonschemaconfig.mdx b/docs/components/formatjsonschemaconfig.mdx index 0ddb8ed41..41ed4000f 100644 --- a/docs/components/formatjsonschemaconfig.mdx +++ b/docs/components/formatjsonschemaconfig.mdx @@ -9,8 +9,8 @@ JSON schema constrained response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `schema_` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `type` | [components.FormatJSONSchemaConfigType](../components/formatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `description` | *Optional[str]* | ➖ | N/A | +| `name` | *str* | ✅ | N/A | +| `schema_` | Dict[str, *Any*] | ✅ | N/A | +| `strict` | *OptionalNullable[bool]* | ➖ | N/A | +| `type` | [components.FormatJSONSchemaConfigType](../components/formatjsonschemaconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/formattext.mdx b/docs/components/formattext.mdx index 61d6f3b9e..5f8a4a169 100644 --- a/docs/components/formattext.mdx +++ b/docs/components/formattext.mdx @@ -6,4 +6,4 @@ title: "FormatText" | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `type` | [components.FormatTypeText](../components/formattypetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.FormatTypeText](../components/formattypetext.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/formattextconfig.mdx b/docs/components/formattextconfig.mdx index 798671326..2bb064f9f 100644 --- a/docs/components/formattextconfig.mdx +++ b/docs/components/formattextconfig.mdx @@ -9,4 +9,4 @@ Plain text response format | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [components.FormatTextConfigType](../components/formattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.FormatTextConfigType](../components/formattextconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/frameimage.mdx b/docs/components/frameimage.mdx index 46b4b985d..a2e39e876 100644 --- a/docs/components/frameimage.mdx +++ b/docs/components/frameimage.mdx @@ -6,6 +6,6 @@ title: "FrameImage" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `image_url` | [components.FrameImageImageURL](../components/frameimageimageurl.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.FrameImageType](../components/frameimagetype.mdx) | :heavy_check_mark: | N/A | | -| `frame_type` | [components.FrameType](../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 +| `image_url` | [components.FrameImageImageURL](../components/frameimageimageurl.mdx) | ✅ | N/A | | +| `type` | [components.FrameImageType](../components/frameimagetype.mdx) | ✅ | N/A | | +| `frame_type` | [components.FrameType](../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/components/frameimageimageurl.mdx b/docs/components/frameimageimageurl.mdx index 713a81f1d..ad4a7de2b 100644 --- a/docs/components/frameimageimageurl.mdx +++ b/docs/components/frameimageimageurl.mdx @@ -6,4 +6,4 @@ title: "FrameImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/freemodeldailyrequests.mdx b/docs/components/freemodeldailyrequests.mdx index b0a9f40d0..4bf505f25 100644 --- a/docs/components/freemodeldailyrequests.mdx +++ b/docs/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` | *int* | :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` | *int* | :heavy_check_mark: | Free-model requests left in the current UTC day | 38 | -| `used` | *int* | :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` | *int* | ✅ | 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` | *int* | ✅ | Free-model requests left in the current UTC day | 38 | +| `used` | *int* | ✅ | 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/components/functioncallargsdeltaevent.mdx b/docs/components/functioncallargsdeltaevent.mdx index e28936eff..d6b954b7a 100644 --- a/docs/components/functioncallargsdeltaevent.mdx +++ b/docs/components/functioncallargsdeltaevent.mdx @@ -9,8 +9,8 @@ Event emitted when function call arguments are being streamed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FunctionCallArgsDeltaEventType](../components/functioncallargsdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.FunctionCallArgsDeltaEventType](../components/functioncallargsdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/functioncallargsdoneevent.mdx b/docs/components/functioncallargsdoneevent.mdx index acc25e399..b2b5fb080 100644 --- a/docs/components/functioncallargsdoneevent.mdx +++ b/docs/components/functioncallargsdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when function call arguments streaming is complete | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FunctionCallArgsDoneEventType](../components/functioncallargsdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `name` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.FunctionCallArgsDoneEventType](../components/functioncallargsdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/functioncallitem.mdx b/docs/components/functioncallitem.mdx index 9d430414f..837846826 100644 --- a/docs/components/functioncallitem.mdx +++ b/docs/components/functioncallitem.mdx @@ -9,13 +9,13 @@ A function call initiated by the model | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | N/A | | -| `async_` | *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 | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *OptionalNullable[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `subagent_id` | *OptionalNullable[str]* | :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. | | -| `subagent_items` | List[[components.FunctionCallItemSubagentItem](../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](../components/functioncallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | | +| `async_` | *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 | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `namespace` | *OptionalNullable[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | +| `subagent_id` | *OptionalNullable[str]* | ➖ | 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. | | +| `subagent_items` | List[[components.FunctionCallItemSubagentItem](../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](../components/functioncallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/functioncallitemsubagentitem.mdx b/docs/components/functioncallitemsubagentitem.mdx index 19df504a4..d77ed7b26 100644 --- a/docs/components/functioncallitemsubagentitem.mdx +++ b/docs/components/functioncallitemsubagentitem.mdx @@ -6,5 +6,5 @@ title: "FunctionCallItemSubagentItem" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *str* | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/functioncalloutputitem.mdx b/docs/components/functioncalloutputitem.mdx index f0bca51ca..f235332ab 100644 --- a/docs/components/functioncalloutputitem.mdx +++ b/docs/components/functioncalloutputitem.mdx @@ -9,8 +9,8 @@ The output from a function call execution | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `output` | [components.FunctionCallOutputItemOutputUnion2](../components/functioncalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../components/functioncalloutputitemtypefunctioncalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `output` | [components.FunctionCallOutputItemOutputUnion2](../components/functioncalloutputitemoutputunion2.mdx) | ✅ | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../components/functioncalloutputitemtypefunctioncalloutput.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/functioncalloutputitemoutputinputimage.mdx b/docs/components/functioncalloutputitemoutputinputimage.mdx index 245498dc2..10d15d89a 100644 --- a/docs/components/functioncalloutputitemoutputinputimage.mdx +++ b/docs/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](../components/functioncalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | -| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.FunctionCallOutputItemOutputType](../components/functioncalloutputitemoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [components.FunctionCallOutputItemDetail](../components/functioncalloutputitemdetail.mdx) | ✅ | N/A | +| `file_id` | *OptionalNullable[str]* | ➖ | N/A | +| `image_url` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.FunctionCallOutputItemOutputType](../components/functioncalloutputitemoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusionanalysisresult.mdx b/docs/components/fusionanalysisresult.mdx index 06562dd23..08fcee4ac 100644 --- a/docs/components/fusionanalysisresult.mdx +++ b/docs/components/fusionanalysisresult.mdx @@ -9,8 +9,8 @@ Structured analysis produced by the fusion analyst model. | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `blind_spots` | List[*str*] | :heavy_check_mark: | N/A | -| `consensus` | List[*str*] | :heavy_check_mark: | N/A | -| `contradictions` | List[[components.Contradiction](../components/contradiction.mdx)] | :heavy_check_mark: | N/A | -| `partial_coverage` | List[[components.PartialCoverage](../components/partialcoverage.mdx)] | :heavy_check_mark: | N/A | -| `unique_insights` | List[[components.UniqueInsight](../components/uniqueinsight.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `blind_spots` | List[*str*] | ✅ | N/A | +| `consensus` | List[*str*] | ✅ | N/A | +| `contradictions` | List[[components.Contradiction](../components/contradiction.mdx)] | ✅ | N/A | +| `partial_coverage` | List[[components.PartialCoverage](../components/partialcoverage.mdx)] | ✅ | N/A | +| `unique_insights` | List[[components.UniqueInsight](../components/uniqueinsight.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallanalysiscompletedevent.mdx b/docs/components/fusioncallanalysiscompletedevent.mdx index 7f295a8c0..4ac75319b 100644 --- a/docs/components/fusioncallanalysiscompletedevent.mdx +++ b/docs/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](../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"
}
]
} | -| `item_id` | *str* | :heavy_check_mark: | N/A | | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.FusionCallAnalysisCompletedEventType](../components/fusioncallanalysiscompletedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `analysis` | [components.FusionAnalysisResult](../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"
}
]
} | +| `item_id` | *str* | ✅ | N/A | | +| `output_index` | *int* | ✅ | N/A | | +| `sequence_number` | *int* | ✅ | N/A | | +| `type` | [components.FusionCallAnalysisCompletedEventType](../components/fusioncallanalysiscompletedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/fusioncallanalysisinprogressevent.mdx b/docs/components/fusioncallanalysisinprogressevent.mdx index 6538c8ffb..278c9a226 100644 --- a/docs/components/fusioncallanalysisinprogressevent.mdx +++ b/docs/components/fusioncallanalysisinprogressevent.mdx @@ -9,9 +9,9 @@ Emitted when the fusion analyst starts producing the structured analysis. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analyst_model` | *str* | :heavy_check_mark: | Slug of the model producing the structured analysis. | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| ~~`judge_model`~~ | *str* | :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`. | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FusionCallAnalysisInProgressEventType](../components/fusioncallanalysisinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `analyst_model` | *str* | ✅ | Slug of the model producing the structured analysis. | +| `item_id` | *str* | ✅ | N/A | +| ~~`judge_model`~~ | *str* | ✅ | : 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`. | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.FusionCallAnalysisInProgressEventType](../components/fusioncallanalysisinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallcompletedevent.mdx b/docs/components/fusioncallcompletedevent.mdx index 400524487..0a972dfff 100644 --- a/docs/components/fusioncallcompletedevent.mdx +++ b/docs/components/fusioncallcompletedevent.mdx @@ -9,7 +9,7 @@ Emitted when the openrouter:fusion tool call finishes. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FusionCallCompletedEventType](../components/fusioncallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.FusionCallCompletedEventType](../components/fusioncallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallinprogressevent.mdx b/docs/components/fusioncallinprogressevent.mdx index 8f27a2d07..b894d5b3b 100644 --- a/docs/components/fusioncallinprogressevent.mdx +++ b/docs/components/fusioncallinprogressevent.mdx @@ -9,7 +9,7 @@ Emitted when an openrouter:fusion tool call begins executing. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FusionCallInProgressEventType](../components/fusioncallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.FusionCallInProgressEventType](../components/fusioncallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpaneladdedevent.mdx b/docs/components/fusioncallpaneladdedevent.mdx index 260884b7d..3b71a029c 100644 --- a/docs/components/fusioncallpaneladdedevent.mdx +++ b/docs/components/fusioncallpaneladdedevent.mdx @@ -9,8 +9,8 @@ Emitted when a fusion analysis-panel model starts. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FusionCallPanelAddedEventType](../components/fusioncallpaneladdedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `model` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.FusionCallPanelAddedEventType](../components/fusioncallpaneladdedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpanelcompletedevent.mdx b/docs/components/fusioncallpanelcompletedevent.mdx index 1d115a6af..bb91231b1 100644 --- a/docs/components/fusioncallpanelcompletedevent.mdx +++ b/docs/components/fusioncallpanelcompletedevent.mdx @@ -9,9 +9,9 @@ Emitted when a fusion panel model finishes with its full content. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `content` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FusionCallPanelCompletedEventType](../components/fusioncallpanelcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `model` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.FusionCallPanelCompletedEventType](../components/fusioncallpanelcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpaneldeltaevent.mdx b/docs/components/fusioncallpaneldeltaevent.mdx index 3f8a569b7..a87bd9640 100644 --- a/docs/components/fusioncallpaneldeltaevent.mdx +++ b/docs/components/fusioncallpaneldeltaevent.mdx @@ -9,9 +9,9 @@ Incremental content token from a fusion panel model. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FusionCallPanelDeltaEventType](../components/fusioncallpaneldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `model` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.FusionCallPanelDeltaEventType](../components/fusioncallpaneldeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpanelfailedevent.mdx b/docs/components/fusioncallpanelfailedevent.mdx index a6c9fa535..8a52799f0 100644 --- a/docs/components/fusioncallpanelfailedevent.mdx +++ b/docs/components/fusioncallpanelfailedevent.mdx @@ -9,10 +9,10 @@ Emitted when a fusion panel model fails. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `error` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `status_code` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `type` | [components.FusionCallPanelFailedEventType](../components/fusioncallpanelfailedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `model` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `status_code` | *Optional[int]* | ➖ | N/A | +| `type` | [components.FusionCallPanelFailedEventType](../components/fusioncallpanelfailedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusioncallpanelreasoningdeltaevent.mdx b/docs/components/fusioncallpanelreasoningdeltaevent.mdx index a25d4c0eb..fc6d5fcbc 100644 --- a/docs/components/fusioncallpanelreasoningdeltaevent.mdx +++ b/docs/components/fusioncallpanelreasoningdeltaevent.mdx @@ -9,9 +9,9 @@ Incremental reasoning token from a fusion panel model. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FusionCallPanelReasoningDeltaEventType](../components/fusioncallpanelreasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `model` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.FusionCallPanelReasoningDeltaEventType](../components/fusioncallpanelreasoningdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/fusionplugin.mdx b/docs/components/fusionplugin.mdx index b9dcf8463..bf9895e5d 100644 --- a/docs/components/fusionplugin.mdx +++ b/docs/components/fusionplugin.mdx @@ -6,10 +6,10 @@ title: "FusionPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis_models` | List[*str*] | :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` | *Optional[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](../components/fusionpluginid.mdx) | :heavy_check_mark: | N/A | | -| `max_tool_calls` | *Optional[int]* | :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` | *Optional[str]* | :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` | [Optional[components.PresetEnum]](../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` | List[[components.FusionPluginTool](../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 +| `analysis_models` | List[*str*] | ➖ | 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` | *Optional[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](../components/fusionpluginid.mdx) | ✅ | N/A | | +| `max_tool_calls` | *Optional[int]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.PresetEnum]](../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` | List[[components.FusionPluginTool](../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/components/fusionplugintool.mdx b/docs/components/fusionplugintool.mdx index 967c0e2ab..32726e1c2 100644 --- a/docs/components/fusionplugintool.mdx +++ b/docs/components/fusionplugintool.mdx @@ -6,5 +6,5 @@ title: "FusionPluginTool" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `parameters` | Dict[str, [Nullable[components.Parameters3]](../components/parameters3.mdx)] | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | -| `type` | *str* | :heavy_check_mark: | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `parameters` | Dict[str, [Nullable[components.Parameters3]](../components/parameters3.mdx)] | ➖ | Optional configuration forwarded as the tool's `parameters` object. | +| `type` | *str* | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file diff --git a/docs/components/fusionservertoolconfig.mdx b/docs/components/fusionservertoolconfig.mdx index 2c2377326..10947deb9 100644 --- a/docs/components/fusionservertoolconfig.mdx +++ b/docs/components/fusionservertoolconfig.mdx @@ -9,11 +9,11 @@ Configuration for the openrouter:fusion server tool. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `analysis_models` | List[*str*] | :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"
] | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `max_completion_tokens` | *Optional[int]* | :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 | -| `max_tool_calls` | *Optional[int]* | :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` | *Optional[str]* | :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` | [Optional[components.FusionServerToolConfigReasoning]](../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` | *Optional[float]* | :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` | List[[components.FusionServerToolConfigTool](../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 +| `analysis_models` | List[*str*] | ➖ | 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"
] | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `max_completion_tokens` | *Optional[int]* | ➖ | 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 | +| `max_tool_calls` | *Optional[int]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.FusionServerToolConfigReasoning]](../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` | *Optional[float]* | ➖ | 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` | List[[components.FusionServerToolConfigTool](../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/components/fusionservertoolconfigreasoning.mdx b/docs/components/fusionservertoolconfigreasoning.mdx index 49dd617c5..5114e6e20 100644 --- a/docs/components/fusionservertoolconfigreasoning.mdx +++ b/docs/components/fusionservertoolconfigreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to panelist and analyst inner calls. Use this | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `effort` | [Optional[components.FusionServerToolConfigEffort]](../components/fusionservertoolconfigeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for panelist and analyst inner calls. | -| `max_tokens` | *Optional[int]* | :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` | [Optional[components.FusionServerToolConfigEffort]](../components/fusionservertoolconfigeffort.mdx) | ➖ | Reasoning effort level for panelist and analyst inner calls. | +| `max_tokens` | *Optional[int]* | ➖ | 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/components/fusionservertoolconfigtool.mdx b/docs/components/fusionservertoolconfigtool.mdx index 486dbbd1c..6ed3cd6d3 100644 --- a/docs/components/fusionservertoolconfigtool.mdx +++ b/docs/components/fusionservertoolconfigtool.mdx @@ -6,5 +6,5 @@ title: "FusionServerToolConfigTool" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | -| `type` | *str* | :heavy_check_mark: | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `parameters` | Dict[str, *Any*] | ➖ | Optional configuration forwarded as the tool's `parameters` object. | +| `type` | *str* | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file diff --git a/docs/components/fusionservertoolopenrouter.mdx b/docs/components/fusionservertoolopenrouter.mdx index 43417bf5d..35ffa1c43 100644 --- a/docs/components/fusionservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.FusionServerToolConfig]](../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](../components/fusionservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.FusionServerToolConfig]](../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](../components/fusionservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/fusionsource.mdx b/docs/components/fusionsource.mdx index 384c9eac3..24dcdfc2c 100644 --- a/docs/components/fusionsource.mdx +++ b/docs/components/fusionsource.mdx @@ -9,5 +9,5 @@ A web page retrieved via web search during a fusion run. | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `title` | *str* | :heavy_check_mark: | Title of the retrieved web page. | -| `url` | *str* | :heavy_check_mark: | URL of the web page a panel or the analyst retrieved during the run. | \ No newline at end of file +| `title` | *str* | ✅ | Title of the retrieved web page. | +| `url` | *str* | ✅ | URL of the web page a panel or the analyst retrieved during the run. | \ No newline at end of file diff --git a/docs/components/gatewaytimeoutresponseerrordata.mdx b/docs/components/gatewaytimeoutresponseerrordata.mdx index 281176afa..10d800ea2 100644 --- a/docs/components/gatewaytimeoutresponseerrordata.mdx +++ b/docs/components/gatewaytimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for GatewayTimeoutResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/generationcontentdata.mdx b/docs/components/generationcontentdata.mdx index 09bc28302..ebd235b37 100644 --- a/docs/components/generationcontentdata.mdx +++ b/docs/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` | [Nullable[components.GenerationContentError]](../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](../components/inputunion.mdx) | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | | -| `output` | [components.GenerationContentDataOutput](../components/generationcontentdataoutput.mdx) | :heavy_check_mark: | The output from the generation | | \ No newline at end of file +| `error` | [Nullable[components.GenerationContentError]](../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](../components/inputunion.mdx) | ✅ | The input to the generation — either a prompt string or an array of messages | | +| `output` | [components.GenerationContentDataOutput](../components/generationcontentdataoutput.mdx) | ✅ | The output from the generation | | \ No newline at end of file diff --git a/docs/components/generationcontentdataoutput.mdx b/docs/components/generationcontentdataoutput.mdx index d497eb12b..d5b7664a7 100644 --- a/docs/components/generationcontentdataoutput.mdx +++ b/docs/components/generationcontentdataoutput.mdx @@ -9,5 +9,5 @@ The output from the generation | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `completion` | *Nullable[str]* | :heavy_check_mark: | The completion output | The meaning of life is a philosophical question... | -| `reasoning` | *Nullable[str]* | :heavy_check_mark: | Reasoning/thinking output, if any | null | \ No newline at end of file +| `completion` | *Nullable[str]* | ✅ | The completion output | The meaning of life is a philosophical question... | +| `reasoning` | *Nullable[str]* | ✅ | Reasoning/thinking output, if any | null | \ No newline at end of file diff --git a/docs/components/generationcontenterror.mdx b/docs/components/generationcontenterror.mdx index f6cee61d8..800c71fa5 100644 --- a/docs/components/generationcontenterror.mdx +++ b/docs/components/generationcontenterror.mdx @@ -9,8 +9,8 @@ The stored failure for this generation, or null when it succeeded | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `message` | *Nullable[str]* | :heavy_check_mark: | Error message returned to the client | Timed out waiting for the provider | -| `previous_errors` | List[[components.GenerationContentErrorAttempt](../components/generationcontenterrorattempt.mdx)] | :heavy_check_mark: | Every upstream attempt that failed before the returned error, in attempt order | | -| `provider_name` | *Nullable[str]* | :heavy_check_mark: | Provider whose error was returned to the client, when known | Vertex | -| `raw` | *Nullable[str]* | :heavy_check_mark: | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | -| `status` | *Nullable[int]* | :heavy_check_mark: | HTTP status returned to the client | 504 | \ No newline at end of file +| `message` | *Nullable[str]* | ✅ | Error message returned to the client | Timed out waiting for the provider | +| `previous_errors` | List[[components.GenerationContentErrorAttempt](../components/generationcontenterrorattempt.mdx)] | ✅ | Every upstream attempt that failed before the returned error, in attempt order | | +| `provider_name` | *Nullable[str]* | ✅ | Provider whose error was returned to the client, when known | Vertex | +| `raw` | *Nullable[str]* | ✅ | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | +| `status` | *Nullable[int]* | ✅ | HTTP status returned to the client | 504 | \ No newline at end of file diff --git a/docs/components/generationcontenterrorattempt.mdx b/docs/components/generationcontenterrorattempt.mdx index cc7ba02b5..c1f8cf89f 100644 --- a/docs/components/generationcontenterrorattempt.mdx +++ b/docs/components/generationcontenterrorattempt.mdx @@ -9,7 +9,7 @@ A single failed upstream attempt recorded for the generation | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `code` | *int* | :heavy_check_mark: | HTTP status returned by this attempt | 429 | -| `message` | *str* | :heavy_check_mark: | Error message returned by this attempt | Provider returned error | -| `provider_name` | *Nullable[str]* | :heavy_check_mark: | Provider that served this attempt, when known | Google | -| `raw` | *Nullable[str]* | :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` | *int* | ✅ | HTTP status returned by this attempt | 429 | +| `message` | *str* | ✅ | Error message returned by this attempt | Provider returned error | +| `provider_name` | *Nullable[str]* | ✅ | Provider that served this attempt, when known | Google | +| `raw` | *Nullable[str]* | ✅ | 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/components/generationcontentresponse.mdx b/docs/components/generationcontentresponse.mdx index 8fab8bcf0..e561545c9 100644 --- a/docs/components/generationcontentresponse.mdx +++ b/docs/components/generationcontentresponse.mdx @@ -9,4 +9,4 @@ Stored prompt and completion content for a generation | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.GenerationContentData](../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](../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/components/generationresponse.mdx b/docs/components/generationresponse.mdx index b876dce8c..bf438056d 100644 --- a/docs/components/generationresponse.mdx +++ b/docs/components/generationresponse.mdx @@ -9,4 +9,4 @@ Generation response | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `data` | [components.GenerationResponseData](../components/generationresponsedata.mdx) | :heavy_check_mark: | Generation data | \ No newline at end of file +| `data` | [components.GenerationResponseData](../components/generationresponsedata.mdx) | ✅ | Generation data | \ No newline at end of file diff --git a/docs/components/generationresponsedata.mdx b/docs/components/generationresponsedata.mdx index bf175271c..942588a0b 100644 --- a/docs/components/generationresponsedata.mdx +++ b/docs/components/generationresponsedata.mdx @@ -9,48 +9,48 @@ Generation data | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_type` | [Nullable[components.APIType]](../components/apitype.mdx) | :heavy_check_mark: | Type of API used for the generation | | -| `app_id` | *Nullable[int]* | :heavy_check_mark: | ID of the app that made the request | 12345 | -| `cache_discount` | *Nullable[float]* | :heavy_check_mark: | Discount applied due to caching | 0.0002 | -| `cancelled` | *Nullable[bool]* | :heavy_check_mark: | Whether the generation was cancelled | false | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `data_region` | [components.GenerationResponseDataRegion](../components/generationresponsedataregion.mdx) | :heavy_check_mark: | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | -| `external_user` | *Nullable[str]* | :heavy_check_mark: | External user identifier | user-123 | -| `finish_reason` | *Nullable[str]* | :heavy_check_mark: | Reason the generation finished | stop | -| `generation_time` | *Nullable[float]* | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | -| `http_referer` | *Nullable[str]* | :heavy_check_mark: | Referer header from the request | | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `is_byok` | *bool* | :heavy_check_mark: | Whether this used bring-your-own-key | false | -| `latency` | *Nullable[float]* | :heavy_check_mark: | Total latency in milliseconds | 1250 | -| `model` | *str* | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | -| `moderation_latency` | *Nullable[float]* | :heavy_check_mark: | Moderation latency in milliseconds | 50 | -| `native_finish_reason` | *Nullable[str]* | :heavy_check_mark: | Native finish reason as reported by provider | stop | -| `native_tokens_cached` | *Nullable[int]* | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | -| `native_tokens_completion` | *Nullable[int]* | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | -| `native_tokens_completion_images` | *Nullable[int]* | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | -| `native_tokens_prompt` | *Nullable[int]* | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | -| `native_tokens_reasoning` | *Nullable[int]* | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | -| `num_fetches` | *Nullable[int]* | :heavy_check_mark: | Number of web fetches performed | 0 | -| `num_input_audio_prompt` | *Nullable[int]* | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | -| `num_media_completion` | *Nullable[int]* | :heavy_check_mark: | Number of media items in the completion | 0 | -| `num_media_prompt` | *Nullable[int]* | :heavy_check_mark: | Number of media items in the prompt | 1 | -| `num_search_results` | *Nullable[int]* | :heavy_check_mark: | Number of search results included | 5 | -| `origin` | *str* | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | -| `preset_id` | *Nullable[str]* | :heavy_check_mark: | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | -| `provider_name` | *Nullable[str]* | :heavy_check_mark: | Name of the provider that served the request | Infermatic | -| `provider_responses` | List[[components.ProviderResponse](../components/providerresponse.mdx)] | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | -| `request_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | -| `response_cache_source_id` | *OptionalNullable[str]* | :heavy_minus_sign: | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | -| `router` | *Nullable[str]* | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | -| `service_tier` | *Nullable[str]* | :heavy_check_mark: | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | -| `session_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Session identifier grouping multiple generations in the same session | | -| `streamed` | *Nullable[bool]* | :heavy_check_mark: | Whether the response was streamed | true | -| `tokens_completion` | *Nullable[int]* | :heavy_check_mark: | Number of tokens in the completion | 25 | -| `tokens_prompt` | *Nullable[int]* | :heavy_check_mark: | Number of tokens in the prompt | 10 | -| `total_cost` | *float* | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | -| `upstream_id` | *Nullable[str]* | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `upstream_inference_cost` | *Nullable[float]* | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | -| `usage` | *float* | :heavy_check_mark: | Usage amount in USD | 0.0015 | -| `user_agent` | *Nullable[str]* | :heavy_check_mark: | User-Agent header from the request | | -| `web_search_engine` | *Nullable[str]* | :heavy_check_mark: | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | -| `workspace_id` | *Nullable[str]* | :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 +| `api_type` | [Nullable[components.APIType]](../components/apitype.mdx) | ✅ | Type of API used for the generation | | +| `app_id` | *Nullable[int]* | ✅ | ID of the app that made the request | 12345 | +| `cache_discount` | *Nullable[float]* | ✅ | Discount applied due to caching | 0.0002 | +| `cancelled` | *Nullable[bool]* | ✅ | Whether the generation was cancelled | false | +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | +| `data_region` | [components.GenerationResponseDataRegion](../components/generationresponsedataregion.mdx) | ✅ | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | +| `external_user` | *Nullable[str]* | ✅ | External user identifier | user-123 | +| `finish_reason` | *Nullable[str]* | ✅ | Reason the generation finished | stop | +| `generation_time` | *Nullable[float]* | ✅ | Time taken for generation in milliseconds | 1200 | +| `http_referer` | *Nullable[str]* | ✅ | Referer header from the request | | +| `id` | *str* | ✅ | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | +| `is_byok` | *bool* | ✅ | Whether this used bring-your-own-key | false | +| `latency` | *Nullable[float]* | ✅ | Total latency in milliseconds | 1250 | +| `model` | *str* | ✅ | Model used for the generation | sao10k/l3-stheno-8b | +| `moderation_latency` | *Nullable[float]* | ✅ | Moderation latency in milliseconds | 50 | +| `native_finish_reason` | *Nullable[str]* | ✅ | Native finish reason as reported by provider | stop | +| `native_tokens_cached` | *Nullable[int]* | ✅ | Native cached tokens as reported by provider | 3 | +| `native_tokens_completion` | *Nullable[int]* | ✅ | Native completion tokens as reported by provider | 25 | +| `native_tokens_completion_images` | *Nullable[int]* | ✅ | Native completion image tokens as reported by provider | 0 | +| `native_tokens_prompt` | *Nullable[int]* | ✅ | Native prompt tokens as reported by provider | 10 | +| `native_tokens_reasoning` | *Nullable[int]* | ✅ | Native reasoning tokens as reported by provider | 5 | +| `num_fetches` | *Nullable[int]* | ✅ | Number of web fetches performed | 0 | +| `num_input_audio_prompt` | *Nullable[int]* | ✅ | Number of audio inputs in the prompt | 0 | +| `num_media_completion` | *Nullable[int]* | ✅ | Number of media items in the completion | 0 | +| `num_media_prompt` | *Nullable[int]* | ✅ | Number of media items in the prompt | 1 | +| `num_search_results` | *Nullable[int]* | ✅ | Number of search results included | 5 | +| `origin` | *str* | ✅ | Origin URL of the request | https://openrouter.ai/ | +| `preset_id` | *Nullable[str]* | ✅ | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | +| `provider_name` | *Nullable[str]* | ✅ | Name of the provider that served the request | Infermatic | +| `provider_responses` | List[[components.ProviderResponse](../components/providerresponse.mdx)] | ✅ | List of provider responses for this generation, including fallback attempts | | +| `request_id` | *OptionalNullable[str]* | ➖ | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | +| `response_cache_source_id` | *OptionalNullable[str]* | ➖ | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | +| `router` | *Nullable[str]* | ✅ | Router used for the request (e.g., openrouter/auto) | openrouter/auto | +| `service_tier` | *Nullable[str]* | ✅ | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | +| `session_id` | *OptionalNullable[str]* | ➖ | Session identifier grouping multiple generations in the same session | | +| `streamed` | *Nullable[bool]* | ✅ | Whether the response was streamed | true | +| `tokens_completion` | *Nullable[int]* | ✅ | Number of tokens in the completion | 25 | +| `tokens_prompt` | *Nullable[int]* | ✅ | Number of tokens in the prompt | 10 | +| `total_cost` | *float* | ✅ | Total cost of the generation in USD | 0.0015 | +| `upstream_id` | *Nullable[str]* | ✅ | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | +| `upstream_inference_cost` | *Nullable[float]* | ✅ | Cost charged by the upstream provider | 0.0012 | +| `usage` | *float* | ✅ | Usage amount in USD | 0.0015 | +| `user_agent` | *Nullable[str]* | ✅ | User-Agent header from the request | | +| `web_search_engine` | *Nullable[str]* | ✅ | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | +| `workspace_id` | *Nullable[str]* | ✅ | 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/components/getbyokkeyresponse.mdx b/docs/components/getbyokkeyresponse.mdx index 30d5539cf..2e804eda0 100644 --- a/docs/components/getbyokkeyresponse.mdx +++ b/docs/components/getbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "GetBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.BYOKKey](../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](../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/components/getguardrailresponse.mdx b/docs/components/getguardrailresponse.mdx index c17bc0e82..efc2eb464 100644 --- a/docs/components/getguardrailresponse.mdx +++ b/docs/components/getguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "GetGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Guardrail](../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](../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/components/getobservabilitydestinationresponse.mdx b/docs/components/getobservabilitydestinationresponse.mdx index f6bfadc5c..7e611ac42 100644 --- a/docs/components/getobservabilitydestinationresponse.mdx +++ b/docs/components/getobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "GetObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ObservabilityDestination](../components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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](../components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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/components/getpresetresponse.mdx b/docs/components/getpresetresponse.mdx index 2af502a12..3606318ff 100644 --- a/docs/components/getpresetresponse.mdx +++ b/docs/components/getpresetresponse.mdx @@ -9,4 +9,4 @@ A preset with its currently designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.PresetWithDesignatedVersion](../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](../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/components/getpresetversionresponse.mdx b/docs/components/getpresetversionresponse.mdx index 6c3040281..6de20820b 100644 --- a/docs/components/getpresetversionresponse.mdx +++ b/docs/components/getpresetversionresponse.mdx @@ -9,4 +9,4 @@ A single version of a preset. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [Nullable[components.PresetDesignatedVersion]](../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` | [Nullable[components.PresetDesignatedVersion]](../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/components/getscimgroupmappingresponse.mdx b/docs/components/getscimgroupmappingresponse.mdx index 3031bf112..43dd8b19c 100644 --- a/docs/components/getscimgroupmappingresponse.mdx +++ b/docs/components/getscimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "GetScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ScimGroupMapping](../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](../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/components/getscimsyncjobresponse.mdx b/docs/components/getscimsyncjobresponse.mdx index e671eabcb..d1d7d379f 100644 --- a/docs/components/getscimsyncjobresponse.mdx +++ b/docs/components/getscimsyncjobresponse.mdx @@ -6,4 +6,4 @@ title: "GetScimSyncJobResponse" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | [components.ScimSyncJob](../components/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.ScimSyncJob](../components/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/gettoolresponse.mdx b/docs/components/gettoolresponse.mdx index 50b8d7f4b..1f9a0aaba 100644 --- a/docs/components/gettoolresponse.mdx +++ b/docs/components/gettoolresponse.mdx @@ -6,4 +6,4 @@ title: "GetToolResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `data` | [components.ServerToolDetails](../components/servertooldetails.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.ServerToolDetails](../components/servertooldetails.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/getworkspacebudgetresponse.mdx b/docs/components/getworkspacebudgetresponse.mdx index 2974de1ff..9222134d2 100644 --- a/docs/components/getworkspacebudgetresponse.mdx +++ b/docs/components/getworkspacebudgetresponse.mdx @@ -6,5 +6,5 @@ title: "GetWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.WorkspaceBudget](../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"
} | -| `include_byok_in_budgets` | *Optional[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](../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"
} | +| `include_byok_in_budgets` | *Optional[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/components/getworkspaceresponse.mdx b/docs/components/getworkspaceresponse.mdx index 3028ce13a..e533fcc3c 100644 --- a/docs/components/getworkspaceresponse.mdx +++ b/docs/components/getworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "GetWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Workspace](../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](../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/components/goneresponseerrordata.mdx b/docs/components/goneresponseerrordata.mdx index 79c5d5a9f..44a775cac 100644 --- a/docs/components/goneresponseerrordata.mdx +++ b/docs/components/goneresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for GoneResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/guardrail.mdx b/docs/components/guardrail.mdx index 2f0f384b3..f28b661d4 100644 --- a/docs/components/guardrail.mdx +++ b/docs/components/guardrail.mdx @@ -6,29 +6,29 @@ title: "Guardrail" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | true | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | -| `allowed_models` | List[*str*] | :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"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntry](../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../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"
}
] | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`enforce_zdr`~~ | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *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 | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `name` | *str* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `updated_at` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | -| `workspace_id` | *Nullable[str]* | :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 +| `allow_safety_retention_google` | *OptionalNullable[bool]* | ➖ | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | true | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | +| `allowed_models` | List[*str*] | ➖ | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | +| `allowed_providers` | List[*str*] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntry](../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../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"
}
] | +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | +| `description` | *OptionalNullable[str]* | ➖ | Description of the guardrail | Guardrail for production environment | +| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`enforce_zdr`~~ | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `id` | *str* | ✅ | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `ignored_models` | List[*str*] | ➖ | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | +| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *bool* | ✅ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. | false | +| `limit_usd` | *OptionalNullable[float]* | ➖ | Spending limit in USD | 100 | +| `name` | *str* | ✅ | Name of the guardrail | Production Guardrail | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `updated_at` | *OptionalNullable[str]* | ➖ | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | +| `workspace_id` | *Nullable[str]* | ✅ | 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/components/image.mdx b/docs/components/image.mdx index 36a2381e7..714f6fb66 100644 --- a/docs/components/image.mdx +++ b/docs/components/image.mdx @@ -6,5 +6,5 @@ title: "Image" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `image_url` | [components.BatchObjectImageURL](../components/batchobjectimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.ChoiceTypeImageURL](../components/choicetypeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `image_url` | [components.BatchObjectImageURL](../components/batchobjectimageurl.mdx) | ✅ | N/A | +| `type` | [components.ChoiceTypeImageURL](../components/choicetypeimageurl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/imageendpoint.mdx b/docs/components/imageendpoint.mdx index 29fa84c13..036b01ff1 100644 --- a/docs/components/imageendpoint.mdx +++ b/docs/components/imageendpoint.mdx @@ -9,10 +9,10 @@ An endpoint that serves a given image model. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_passthrough_parameters` | List[*str*] | :heavy_check_mark: | Provider-specific options accepted under provider.options[provider_slug]. | [] | -| `pricing` | List[[components.ImagePricingEntry](../components/imagepricingentry.mdx)] | :heavy_check_mark: | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | -| `provider_name` | *str* | :heavy_check_mark: | Provider display name | Bytedance | -| `provider_slug` | *str* | :heavy_check_mark: | Provider slug | bytedance | -| `provider_tag` | *Nullable[str]* | :heavy_check_mark: | Provider tag for request-side selection | bytedance | -| `supported_parameters` | Dict[str, [components.CapabilityDescriptor](../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"
}
} | -| `supports_streaming` | *bool* | :heavy_check_mark: | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file +| `allowed_passthrough_parameters` | List[*str*] | ✅ | Provider-specific options accepted under provider.options[provider_slug]. | [] | +| `pricing` | List[[components.ImagePricingEntry](../components/imagepricingentry.mdx)] | ✅ | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | +| `provider_name` | *str* | ✅ | Provider display name | Bytedance | +| `provider_slug` | *str* | ✅ | Provider slug | bytedance | +| `provider_tag` | *Nullable[str]* | ✅ | Provider tag for request-side selection | bytedance | +| `supported_parameters` | Dict[str, [components.CapabilityDescriptor](../components/capabilitydescriptor.mdx)] | ✅ | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | +| `supports_streaming` | *bool* | ✅ | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file diff --git a/docs/components/imagegencallcompletedevent.mdx b/docs/components/imagegencallcompletedevent.mdx index 2ca428b13..7657c7727 100644 --- a/docs/components/imagegencallcompletedevent.mdx +++ b/docs/components/imagegencallcompletedevent.mdx @@ -9,7 +9,7 @@ Image generation call completed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ImageGenCallCompletedEventType](../components/imagegencallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ImageGenCallCompletedEventType](../components/imagegencallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/imagegencallgeneratingevent.mdx b/docs/components/imagegencallgeneratingevent.mdx index eb3a1af69..60d65c905 100644 --- a/docs/components/imagegencallgeneratingevent.mdx +++ b/docs/components/imagegencallgeneratingevent.mdx @@ -9,7 +9,7 @@ Image generation call is generating | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ImageGenCallGeneratingEventType](../components/imagegencallgeneratingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ImageGenCallGeneratingEventType](../components/imagegencallgeneratingeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/imagegencallinprogressevent.mdx b/docs/components/imagegencallinprogressevent.mdx index 72ce2bb45..fec386c86 100644 --- a/docs/components/imagegencallinprogressevent.mdx +++ b/docs/components/imagegencallinprogressevent.mdx @@ -9,7 +9,7 @@ Image generation call in progress | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ImageGenCallInProgressEventType](../components/imagegencallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ImageGenCallInProgressEventType](../components/imagegencallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/imagegencallpartialimageevent.mdx b/docs/components/imagegencallpartialimageevent.mdx index a3b82a920..4f4c5acad 100644 --- a/docs/components/imagegencallpartialimageevent.mdx +++ b/docs/components/imagegencallpartialimageevent.mdx @@ -9,9 +9,9 @@ Image generation call with partial image | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `partial_image_b64` | *str* | :heavy_check_mark: | N/A | -| `partial_image_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ImageGenCallPartialImageEventType](../components/imagegencallpartialimageeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `partial_image_b64` | *str* | ✅ | N/A | +| `partial_image_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ImageGenCallPartialImageEventType](../components/imagegencallpartialimageeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/imagegencompletedevent.mdx b/docs/components/imagegencompletedevent.mdx index 247d9e47e..1c59c7589 100644 --- a/docs/components/imagegencompletedevent.mdx +++ b/docs/components/imagegencompletedevent.mdx @@ -9,8 +9,8 @@ Emitted when generation completes and the final image is available | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `b64_json` | *str* | :heavy_check_mark: | Base64-encoded final image data | | -| `created` | *int* | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | | -| `media_type` | *Optional[str]* | :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](../components/imagegencompletedeventtype.mdx) | :heavy_check_mark: | The event type | | -| `usage` | [Optional[components.ImageGenerationUsage]](../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 +| `b64_json` | *str* | ✅ | Base64-encoded final image data | | +| `created` | *int* | ✅ | Unix timestamp (seconds) when the image was generated | | +| `media_type` | *Optional[str]* | ➖ | 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](../components/imagegencompletedeventtype.mdx) | ✅ | The event type | | +| `usage` | [Optional[components.ImageGenerationUsage]](../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/components/imagegeneration.mdx b/docs/components/imagegeneration.mdx index 55213d229..77cb82034 100644 --- a/docs/components/imagegeneration.mdx +++ b/docs/components/imagegeneration.mdx @@ -6,6 +6,6 @@ title: "ImageGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../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` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/imagegenerationproviderpreferences.mdx b/docs/components/imagegenerationproviderpreferences.mdx index b98f786f6..600054638 100644 --- a/docs/components/imagegenerationproviderpreferences.mdx +++ b/docs/components/imagegenerationproviderpreferences.mdx @@ -9,9 +9,9 @@ Provider routing preferences and provider-specific passthrough configuration. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allow_fallbacks` | *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` | List[[components.ImageGenerationProviderPreferencesIgnore](../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` | List[[components.ImageGenerationProviderPreferencesOnly](../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` | [Optional[components.ImageGenerationProviderPreferencesOptions]](../components/imagegenerationproviderpreferencesoptions.mdx) | :heavy_minus_sign: | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | -| `order` | List[[components.ImageGenerationProviderPreferencesOrder](../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[components.ImageGenerationProviderPreferencesSort]](../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 +| `allow_fallbacks` | *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` | List[[components.ImageGenerationProviderPreferencesIgnore](../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` | List[[components.ImageGenerationProviderPreferencesOnly](../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` | [Optional[components.ImageGenerationProviderPreferencesOptions]](../components/imagegenerationproviderpreferencesoptions.mdx) | ➖ | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | +| `order` | List[[components.ImageGenerationProviderPreferencesOrder](../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[components.ImageGenerationProviderPreferencesSort]](../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/components/imagegenerationproviderpreferencesoptions.mdx b/docs/components/imagegenerationproviderpreferencesoptions.mdx index 815789c44..25fbab524 100644 --- a/docs/components/imagegenerationproviderpreferencesoptions.mdx +++ b/docs/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` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ai21` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `aion_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `akashml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `alibaba` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `amazon_bedrock` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `amazon_nova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ambient` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `anthropic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `anthropic_2` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `anyscale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `arcee_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `assemblyai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `atlas_cloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `atoma` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `avian` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `azure` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `baidu` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `baseten` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `black_forest_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `byteplus` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `centml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cerebras` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `chutes` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cirrascale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `clarifai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cloudflare` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cohere` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `coreweave` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cosine` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `crofai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `crucible` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `crusoe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `darkbloom` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `databricks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `decart` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deepgram` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deepinfra` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deepseek` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `dekallm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `digitalocean` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `elevenlabs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `enfer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `fake_provider` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `featherless` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `fireworks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `fish_audio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `friendli` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `gmicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `google_ai_studio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `google_vertex` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `gopomelo` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `groq` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `heygen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `huggingface` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `hyperbolic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `hyperbolic_quantized` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inception` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inferact_vllm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inference_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `infermatic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inocloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `io_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ionstream` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `klusterai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `krea` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lambda_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lepton` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `liquid` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lynn` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lynn_private` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `makora` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mancer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mancer_old` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mara` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `meta` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `minimax` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mistral` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `modal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `modelrun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `modular` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `moonshotai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `morph` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ncompass` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `near_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nebius` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nex_agi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nextbit` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nineteen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `novita` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nvidia` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `octoai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ollama` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `open_inference` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `openai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `parasail` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `perceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `perplexity` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `phala` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `poolside` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `primeintellect` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `quiver` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `recraft` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `recursal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `reflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `reka` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `relace` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `replicate` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `respan` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `runway` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sail_research` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sakana` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sakana_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sambanova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sambanova_cloaked` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `scaledown` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `seed` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sf_compute` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `siliconflow` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sourceful` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `stealth` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `stepfun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `streamlake` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `switchpoint` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `targon` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `tencent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `tenstorrent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `thinkingmachines` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `together` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `together_lite` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `typesafe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ubicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `unbiased` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `upstage` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `venice` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `voyageai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `wafer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `wandb` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `wandb_legacy` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `xai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `xiaomi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `z_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `oneai` | Dict[str, *Any*] | ➖ | N/A | +| `ai21` | Dict[str, *Any*] | ➖ | N/A | +| `aion_labs` | Dict[str, *Any*] | ➖ | N/A | +| `akashml` | Dict[str, *Any*] | ➖ | N/A | +| `alibaba` | Dict[str, *Any*] | ➖ | N/A | +| `amazon_bedrock` | Dict[str, *Any*] | ➖ | N/A | +| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | +| `amazon_nova` | Dict[str, *Any*] | ➖ | N/A | +| `ambient` | Dict[str, *Any*] | ➖ | N/A | +| `anthropic` | Dict[str, *Any*] | ➖ | N/A | +| `anthropic_2` | Dict[str, *Any*] | ➖ | N/A | +| `anyscale` | Dict[str, *Any*] | ➖ | N/A | +| `arcee_ai` | Dict[str, *Any*] | ➖ | N/A | +| `assemblyai` | Dict[str, *Any*] | ➖ | N/A | +| `atlas_cloud` | Dict[str, *Any*] | ➖ | N/A | +| `atoma` | Dict[str, *Any*] | ➖ | N/A | +| `avian` | Dict[str, *Any*] | ➖ | N/A | +| `azure` | Dict[str, *Any*] | ➖ | N/A | +| `baidu` | Dict[str, *Any*] | ➖ | N/A | +| `baseten` | Dict[str, *Any*] | ➖ | N/A | +| `black_forest_labs` | Dict[str, *Any*] | ➖ | N/A | +| `byteplus` | Dict[str, *Any*] | ➖ | N/A | +| `centml` | Dict[str, *Any*] | ➖ | N/A | +| `cerebras` | Dict[str, *Any*] | ➖ | N/A | +| `chutes` | Dict[str, *Any*] | ➖ | N/A | +| `cirrascale` | Dict[str, *Any*] | ➖ | N/A | +| `clarifai` | Dict[str, *Any*] | ➖ | N/A | +| `claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | +| `cloudflare` | Dict[str, *Any*] | ➖ | N/A | +| `cohere` | Dict[str, *Any*] | ➖ | N/A | +| `coreweave` | Dict[str, *Any*] | ➖ | N/A | +| `cosine` | Dict[str, *Any*] | ➖ | N/A | +| `crofai` | Dict[str, *Any*] | ➖ | N/A | +| `crucible` | Dict[str, *Any*] | ➖ | N/A | +| `crusoe` | Dict[str, *Any*] | ➖ | N/A | +| `darkbloom` | Dict[str, *Any*] | ➖ | N/A | +| `databricks` | Dict[str, *Any*] | ➖ | N/A | +| `decart` | Dict[str, *Any*] | ➖ | N/A | +| `deepgram` | Dict[str, *Any*] | ➖ | N/A | +| `deepinfra` | Dict[str, *Any*] | ➖ | N/A | +| `deepseek` | Dict[str, *Any*] | ➖ | N/A | +| `dekallm` | Dict[str, *Any*] | ➖ | N/A | +| `digitalocean` | Dict[str, *Any*] | ➖ | N/A | +| `elevenlabs` | Dict[str, *Any*] | ➖ | N/A | +| `enfer` | Dict[str, *Any*] | ➖ | N/A | +| `fake_provider` | Dict[str, *Any*] | ➖ | N/A | +| `featherless` | Dict[str, *Any*] | ➖ | N/A | +| `fireworks` | Dict[str, *Any*] | ➖ | N/A | +| `fish_audio` | Dict[str, *Any*] | ➖ | N/A | +| `friendli` | Dict[str, *Any*] | ➖ | N/A | +| `gmicloud` | Dict[str, *Any*] | ➖ | N/A | +| `google_ai_studio` | Dict[str, *Any*] | ➖ | N/A | +| `google_vertex` | Dict[str, *Any*] | ➖ | N/A | +| `gopomelo` | Dict[str, *Any*] | ➖ | N/A | +| `groq` | Dict[str, *Any*] | ➖ | N/A | +| `heygen` | Dict[str, *Any*] | ➖ | N/A | +| `huggingface` | Dict[str, *Any*] | ➖ | N/A | +| `hyperbolic` | Dict[str, *Any*] | ➖ | N/A | +| `hyperbolic_quantized` | Dict[str, *Any*] | ➖ | N/A | +| `inception` | Dict[str, *Any*] | ➖ | N/A | +| `inceptron` | Dict[str, *Any*] | ➖ | N/A | +| `inferact_vllm` | Dict[str, *Any*] | ➖ | N/A | +| `inference_net` | Dict[str, *Any*] | ➖ | N/A | +| `infermatic` | Dict[str, *Any*] | ➖ | N/A | +| `inflection` | Dict[str, *Any*] | ➖ | N/A | +| `inocloud` | Dict[str, *Any*] | ➖ | N/A | +| `io_net` | Dict[str, *Any*] | ➖ | N/A | +| `ionstream` | Dict[str, *Any*] | ➖ | N/A | +| `klusterai` | Dict[str, *Any*] | ➖ | N/A | +| `krea` | Dict[str, *Any*] | ➖ | N/A | +| `lambda_` | Dict[str, *Any*] | ➖ | N/A | +| `lepton` | Dict[str, *Any*] | ➖ | N/A | +| `liquid` | Dict[str, *Any*] | ➖ | N/A | +| `lynn` | Dict[str, *Any*] | ➖ | N/A | +| `lynn_private` | Dict[str, *Any*] | ➖ | N/A | +| `makora` | Dict[str, *Any*] | ➖ | N/A | +| `mancer` | Dict[str, *Any*] | ➖ | N/A | +| `mancer_old` | Dict[str, *Any*] | ➖ | N/A | +| `mara` | Dict[str, *Any*] | ➖ | N/A | +| `meta` | Dict[str, *Any*] | ➖ | N/A | +| `minimax` | Dict[str, *Any*] | ➖ | N/A | +| `mistral` | Dict[str, *Any*] | ➖ | N/A | +| `modal` | Dict[str, *Any*] | ➖ | N/A | +| `modelrun` | Dict[str, *Any*] | ➖ | N/A | +| `modular` | Dict[str, *Any*] | ➖ | N/A | +| `moonshotai` | Dict[str, *Any*] | ➖ | N/A | +| `morph` | Dict[str, *Any*] | ➖ | N/A | +| `ncompass` | Dict[str, *Any*] | ➖ | N/A | +| `near_ai` | Dict[str, *Any*] | ➖ | N/A | +| `nebius` | Dict[str, *Any*] | ➖ | N/A | +| `nex_agi` | Dict[str, *Any*] | ➖ | N/A | +| `nextbit` | Dict[str, *Any*] | ➖ | N/A | +| `nineteen` | Dict[str, *Any*] | ➖ | N/A | +| `novita` | Dict[str, *Any*] | ➖ | N/A | +| `nvidia` | Dict[str, *Any*] | ➖ | N/A | +| `octoai` | Dict[str, *Any*] | ➖ | N/A | +| `ollama` | Dict[str, *Any*] | ➖ | N/A | +| `open_inference` | Dict[str, *Any*] | ➖ | N/A | +| `openai` | Dict[str, *Any*] | ➖ | N/A | +| `parasail` | Dict[str, *Any*] | ➖ | N/A | +| `perceptron` | Dict[str, *Any*] | ➖ | N/A | +| `perplexity` | Dict[str, *Any*] | ➖ | N/A | +| `phala` | Dict[str, *Any*] | ➖ | N/A | +| `poolside` | Dict[str, *Any*] | ➖ | N/A | +| `primeintellect` | Dict[str, *Any*] | ➖ | N/A | +| `quiver` | Dict[str, *Any*] | ➖ | N/A | +| `recraft` | Dict[str, *Any*] | ➖ | N/A | +| `recursal` | Dict[str, *Any*] | ➖ | N/A | +| `reflection` | Dict[str, *Any*] | ➖ | N/A | +| `reka` | Dict[str, *Any*] | ➖ | N/A | +| `relace` | Dict[str, *Any*] | ➖ | N/A | +| `replicate` | Dict[str, *Any*] | ➖ | N/A | +| `respan` | Dict[str, *Any*] | ➖ | N/A | +| `runway` | Dict[str, *Any*] | ➖ | N/A | +| `sail_research` | Dict[str, *Any*] | ➖ | N/A | +| `sakana` | Dict[str, *Any*] | ➖ | N/A | +| `sakana_ai` | Dict[str, *Any*] | ➖ | N/A | +| `sambanova` | Dict[str, *Any*] | ➖ | N/A | +| `sambanova_cloaked` | Dict[str, *Any*] | ➖ | N/A | +| `scaledown` | Dict[str, *Any*] | ➖ | N/A | +| `seed` | Dict[str, *Any*] | ➖ | N/A | +| `sf_compute` | Dict[str, *Any*] | ➖ | N/A | +| `siliconflow` | Dict[str, *Any*] | ➖ | N/A | +| `sourceful` | Dict[str, *Any*] | ➖ | N/A | +| `stealth` | Dict[str, *Any*] | ➖ | N/A | +| `stepfun` | Dict[str, *Any*] | ➖ | N/A | +| `streamlake` | Dict[str, *Any*] | ➖ | N/A | +| `switchpoint` | Dict[str, *Any*] | ➖ | N/A | +| `targon` | Dict[str, *Any*] | ➖ | N/A | +| `tencent` | Dict[str, *Any*] | ➖ | N/A | +| `tenstorrent` | Dict[str, *Any*] | ➖ | N/A | +| `thinkingmachines` | Dict[str, *Any*] | ➖ | N/A | +| `together` | Dict[str, *Any*] | ➖ | N/A | +| `together_lite` | Dict[str, *Any*] | ➖ | N/A | +| `typesafe` | Dict[str, *Any*] | ➖ | N/A | +| `ubicloud` | Dict[str, *Any*] | ➖ | N/A | +| `unbiased` | Dict[str, *Any*] | ➖ | N/A | +| `upstage` | Dict[str, *Any*] | ➖ | N/A | +| `venice` | Dict[str, *Any*] | ➖ | N/A | +| `voyageai` | Dict[str, *Any*] | ➖ | N/A | +| `wafer` | Dict[str, *Any*] | ➖ | N/A | +| `wandb` | Dict[str, *Any*] | ➖ | N/A | +| `wandb_legacy` | Dict[str, *Any*] | ➖ | N/A | +| `xai` | Dict[str, *Any*] | ➖ | N/A | +| `xiaomi` | Dict[str, *Any*] | ➖ | N/A | +| `z_ai` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/imagegenerationrequest.mdx b/docs/components/imagegenerationrequest.mdx index 6c22de5c8..8f03555a9 100644 --- a/docs/components/imagegenerationrequest.mdx +++ b/docs/components/imagegenerationrequest.mdx @@ -9,20 +9,20 @@ Image generation request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `aspect_ratio` | [Optional[components.ImageGenerationRequestAspectRatio]](../components/imagegenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | -| `background` | [Optional[components.ImageGenerationRequestBackground]](../components/imagegenerationrequestbackground.mdx) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | -| `input_references` | List[[components.ContentPartImage](../components/contentpartimage.mdx)] | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | -| `model` | *str* | :heavy_check_mark: | The image generation model to use | bytedance-seed/seedream-4.5 | -| `n` | *Optional[int]* | :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 | -| `output_compression` | *Optional[int]* | :heavy_minus_sign: | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | -| `output_format` | [Optional[components.ImageGenerationRequestOutputFormat]](../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` | *str* | :heavy_check_mark: | Text description of the desired image | a red panda astronaut floating in space, studio lighting | -| `provider` | [Optional[components.ImageGenerationProviderPreferences]](../components/imagegenerationproviderpreferences.mdx) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | -| `quality` | [Optional[components.ImageGenerationRequestQuality]](../components/imagegenerationrequestquality.mdx) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | -| `resolution` | [Optional[components.ImageGenerationRequestResolution]](../components/imagegenerationrequestresolution.mdx) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | -| `seed` | *Optional[int]* | :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. | | -| `session_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | *Optional[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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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 +| `aspect_ratio` | [Optional[components.ImageGenerationRequestAspectRatio]](../components/imagegenerationrequestaspectratio.mdx) | ➖ | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | +| `background` | [Optional[components.ImageGenerationRequestBackground]](../components/imagegenerationrequestbackground.mdx) | ➖ | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | +| `input_references` | List[[components.ContentPartImage](../components/contentpartimage.mdx)] | ➖ | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | +| `model` | *str* | ✅ | The image generation model to use | bytedance-seed/seedream-4.5 | +| `n` | *Optional[int]* | ➖ | 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 | +| `output_compression` | *Optional[int]* | ➖ | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | +| `output_format` | [Optional[components.ImageGenerationRequestOutputFormat]](../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` | *str* | ✅ | Text description of the desired image | a red panda astronaut floating in space, studio lighting | +| `provider` | [Optional[components.ImageGenerationProviderPreferences]](../components/imagegenerationproviderpreferences.mdx) | ➖ | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | +| `quality` | [Optional[components.ImageGenerationRequestQuality]](../components/imagegenerationrequestquality.mdx) | ➖ | Rendering quality. Providers without a quality knob ignore this. | high | +| `resolution` | [Optional[components.ImageGenerationRequestResolution]](../components/imagegenerationrequestresolution.mdx) | ➖ | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | +| `seed` | *Optional[int]* | ➖ | 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. | | +| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | *Optional[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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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/components/imagegenerationresponse.mdx b/docs/components/imagegenerationresponse.mdx index b6e0e2c0d..84bbadd89 100644 --- a/docs/components/imagegenerationresponse.mdx +++ b/docs/components/imagegenerationresponse.mdx @@ -9,6 +9,6 @@ Image generation response | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `created` | *int* | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | 1748372400 | -| `data` | List[[components.ImageGenerationResponseData](../components/imagegenerationresponsedata.mdx)] | :heavy_check_mark: | Generated images | | -| `usage` | [Optional[components.ImageGenerationUsage]](../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` | *int* | ✅ | Unix timestamp (seconds) when the image was generated | 1748372400 | +| `data` | List[[components.ImageGenerationResponseData](../components/imagegenerationresponsedata.mdx)] | ✅ | Generated images | | +| `usage` | [Optional[components.ImageGenerationUsage]](../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/components/imagegenerationresponsedata.mdx b/docs/components/imagegenerationresponsedata.mdx index e36ed8937..e5f6cb265 100644 --- a/docs/components/imagegenerationresponsedata.mdx +++ b/docs/components/imagegenerationresponsedata.mdx @@ -6,5 +6,5 @@ title: "ImageGenerationResponseData" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `b64_json` | *str* | :heavy_check_mark: | Base64-encoded image bytes | | -| `media_type` | *Optional[str]* | :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 +| `b64_json` | *str* | ✅ | Base64-encoded image bytes | | +| `media_type` | *Optional[str]* | ➖ | 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/components/imagegenerationservertool.mdx b/docs/components/imagegenerationservertool.mdx index c620407af..76374aab4 100644 --- a/docs/components/imagegenerationservertool.mdx +++ b/docs/components/imagegenerationservertool.mdx @@ -9,14 +9,14 @@ Image generation tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `background` | [Optional[components.ImageGenerationServerToolBackground]](../components/imagegenerationservertoolbackground.mdx) | :heavy_minus_sign: | N/A | -| `input_fidelity` | [OptionalNullable[components.InputFidelity]](../components/inputfidelity.mdx) | :heavy_minus_sign: | N/A | -| `input_image_mask` | [Optional[components.InputImageMask]](../components/inputimagemask.mdx) | :heavy_minus_sign: | N/A | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `moderation` | [Optional[components.Moderation]](../components/moderation.mdx) | :heavy_minus_sign: | N/A | -| `output_compression` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `output_format` | [Optional[components.ImageGenerationServerToolOutputFormat]](../components/imagegenerationservertooloutputformat.mdx) | :heavy_minus_sign: | N/A | -| `partial_images` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `quality` | [Optional[components.ImageGenerationServerToolQuality]](../components/imagegenerationservertoolquality.mdx) | :heavy_minus_sign: | N/A | -| `size` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.ImageGenerationServerToolType](../components/imagegenerationservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `background` | [Optional[components.ImageGenerationServerToolBackground]](../components/imagegenerationservertoolbackground.mdx) | ➖ | N/A | +| `input_fidelity` | [OptionalNullable[components.InputFidelity]](../components/inputfidelity.mdx) | ➖ | N/A | +| `input_image_mask` | [Optional[components.InputImageMask]](../components/inputimagemask.mdx) | ➖ | N/A | +| `model` | *Optional[str]* | ➖ | N/A | +| `moderation` | [Optional[components.Moderation]](../components/moderation.mdx) | ➖ | N/A | +| `output_compression` | *Optional[int]* | ➖ | N/A | +| `output_format` | [Optional[components.ImageGenerationServerToolOutputFormat]](../components/imagegenerationservertooloutputformat.mdx) | ➖ | N/A | +| `partial_images` | *Optional[int]* | ➖ | N/A | +| `quality` | [Optional[components.ImageGenerationServerToolQuality]](../components/imagegenerationservertoolquality.mdx) | ➖ | N/A | +| `size` | *Optional[str]* | ➖ | N/A | +| `type` | [components.ImageGenerationServerToolType](../components/imagegenerationservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/imagegenerationservertoolconfig.mdx b/docs/components/imagegenerationservertoolconfig.mdx index 3fc78f9b0..f0e1a009f 100644 --- a/docs/components/imagegenerationservertoolconfig.mdx +++ b/docs/components/imagegenerationservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:image_generation server tool. Accepts all image | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `model` | *Optional[str]* | :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 | -| `__pydantic_extra__` | Dict[str, [components.ImageGenerationServerToolConfigUnion](../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` | *Optional[str]* | ➖ | Which image generation model to use (e.g. "openai/gpt-5-image"). Defaults to "openai/gpt-5-image". | openai/gpt-5-image | +| `__pydantic_extra__` | Dict[str, [components.ImageGenerationServerToolConfigUnion](../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/components/imagegenerationservertoolopenrouter.mdx b/docs/components/imagegenerationservertoolopenrouter.mdx index 0caf29cf4..213c2a253 100644 --- a/docs/components/imagegenerationservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.ImageGenerationServerToolConfig]](../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](../components/imagegenerationservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.ImageGenerationServerToolConfig]](../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](../components/imagegenerationservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/imagegenerationusage.mdx b/docs/components/imagegenerationusage.mdx index fa7df815c..8c2539d3c 100644 --- a/docs/components/imagegenerationusage.mdx +++ b/docs/components/imagegenerationusage.mdx @@ -9,16 +9,16 @@ Token and cost usage for the image generation request, when available | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completion_tokens` | *int* | :heavy_check_mark: | The tokens generated | | -| `completion_tokens_details` | [OptionalNullable[components.ImageGenerationUsageCompletionTokensDetails]](../components/imagegenerationusagecompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | -| `prompt_tokens` | *int* | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `prompt_tokens_details` | [OptionalNullable[components.ImageGenerationUsagePromptTokensDetails]](../components/imagegenerationusageprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `server_tool_use` | [OptionalNullable[components.ImageGenerationUsageServerToolUse]](../components/imagegenerationusageservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | -| `total_tokens` | *int* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `cache_creation` | [OptionalNullable[components.AnthropicCacheCreation]](../components/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completion_tokens` | *int* | ✅ | The tokens generated | | +| `completion_tokens_details` | [OptionalNullable[components.ImageGenerationUsageCompletionTokensDetails]](../components/imagegenerationusagecompletiontokensdetails.mdx) | ➖ | N/A | | +| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | +| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | List[[components.AnthropicUsageIteration](../components/anthropicusageiteration.mdx)] | ➖ | N/A | | +| `prompt_tokens` | *int* | ✅ | Including images, input audio, and tools if any | | +| `prompt_tokens_details` | [OptionalNullable[components.ImageGenerationUsagePromptTokensDetails]](../components/imagegenerationusageprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | +| `server_tool_use` | [OptionalNullable[components.ImageGenerationUsageServerToolUse]](../components/imagegenerationusageservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `service_tier` | *OptionalNullable[str]* | ➖ | The service tier used by the upstream provider for this request | | +| `speed` | [OptionalNullable[components.AnthropicSpeed]](../components/anthropicspeed.mdx) | ➖ | N/A | standard | +| `total_tokens` | *int* | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/components/imagegenerationusagecompletiontokensdetails.mdx b/docs/components/imagegenerationusagecompletiontokensdetails.mdx index 9c56a843c..5cf574f66 100644 --- a/docs/components/imagegenerationusagecompletiontokensdetails.mdx +++ b/docs/components/imagegenerationusagecompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "ImageGenerationUsageCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `image_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for audio output. | +| `image_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for image output. | +| `reasoning_tokens` | *OptionalNullable[int]* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/components/imagegenerationusageprompttokensdetails.mdx b/docs/components/imagegenerationusageprompttokensdetails.mdx index a00b12547..48330d542 100644 --- a/docs/components/imagegenerationusageprompttokensdetails.mdx +++ b/docs/components/imagegenerationusageprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input audio. | -| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `file_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `video_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audio_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input audio. | +| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cached_tokens` | *OptionalNullable[int]* | ➖ | Tokens cached by the endpoint. | +| `file_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input files/documents. | +| `video_tokens` | *OptionalNullable[int]* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/components/imagegenerationusageservertooluse.mdx b/docs/components/imagegenerationusageservertooluse.mdx index 427cf8d0f..81518f32a 100644 --- a/docs/components/imagegenerationusageservertooluse.mdx +++ b/docs/components/imagegenerationusageservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | :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. | -| `web_search_requests` | *OptionalNullable[int]* | :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 +| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | +| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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/components/imagegenpartialimageevent.mdx b/docs/components/imagegenpartialimageevent.mdx index b081c1148..947b96713 100644 --- a/docs/components/imagegenpartialimageevent.mdx +++ b/docs/components/imagegenpartialimageevent.mdx @@ -9,6 +9,6 @@ Emitted when a partial image becomes available during streaming generation | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `b64_json` | *str* | :heavy_check_mark: | Base64-encoded partial image data | -| `partial_image_index` | *int* | :heavy_check_mark: | 0-based index indicating which partial image this is in the sequence | -| `type` | [components.ImageGenPartialImageEventType](../components/imagegenpartialimageeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file +| `b64_json` | *str* | ✅ | Base64-encoded partial image data | +| `partial_image_index` | *int* | ✅ | 0-based index indicating which partial image this is in the sequence | +| `type` | [components.ImageGenPartialImageEventType](../components/imagegenpartialimageeventtype.mdx) | ✅ | The event type | \ No newline at end of file diff --git a/docs/components/imagegenstreamerrorevent.mdx b/docs/components/imagegenstreamerrorevent.mdx index befd44245..75ba7aca1 100644 --- a/docs/components/imagegenstreamerrorevent.mdx +++ b/docs/components/imagegenstreamerrorevent.mdx @@ -9,5 +9,5 @@ Emitted when streaming generation fails after the SSE response starts | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `error` | [components.ImageGenStreamErrorEventError](../components/imagegenstreamerroreventerror.mdx) | :heavy_check_mark: | Provider error details | -| `type` | [components.ImageGenStreamErrorEventType](../components/imagegenstreamerroreventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file +| `error` | [components.ImageGenStreamErrorEventError](../components/imagegenstreamerroreventerror.mdx) | ✅ | Provider error details | +| `type` | [components.ImageGenStreamErrorEventType](../components/imagegenstreamerroreventtype.mdx) | ✅ | The event type | \ No newline at end of file diff --git a/docs/components/imagegenstreamerroreventerror.mdx b/docs/components/imagegenstreamerroreventerror.mdx index 8539997c0..c6acc34e5 100644 --- a/docs/components/imagegenstreamerroreventerror.mdx +++ b/docs/components/imagegenstreamerroreventerror.mdx @@ -9,7 +9,7 @@ Provider error details | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `code` | *OptionalNullable[str]* | :heavy_minus_sign: | Provider error code, when supplied | -| `message` | *str* | :heavy_check_mark: | Provider error message | -| `param` | *OptionalNullable[str]* | :heavy_minus_sign: | Request parameter associated with the error, when supplied | -| `type` | *OptionalNullable[str]* | :heavy_minus_sign: | Provider error type, when supplied | \ No newline at end of file +| `code` | *OptionalNullable[str]* | ➖ | Provider error code, when supplied | +| `message` | *str* | ✅ | Provider error message | +| `param` | *OptionalNullable[str]* | ➖ | Request parameter associated with the error, when supplied | +| `type` | *OptionalNullable[str]* | ➖ | Provider error type, when supplied | \ No newline at end of file diff --git a/docs/components/imagegentextchunkevent.mdx b/docs/components/imagegentextchunkevent.mdx index 9c2837aab..637fe9e45 100644 --- a/docs/components/imagegentextchunkevent.mdx +++ b/docs/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](../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` | *str* | :heavy_check_mark: | A text fragment of the image being generated (e.g. partial SVG markup) | -| `type` | [components.ImageGenTextChunkEventType](../components/imagegentextchunkeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file +| `phase` | [components.ImageGenTextChunkEventPhase](../components/imagegentextchunkeventphase.mdx) | ✅ | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | +| `text` | *str* | ✅ | A text fragment of the image being generated (e.g. partial SVG markup) | +| `type` | [components.ImageGenTextChunkEventType](../components/imagegentextchunkeventtype.mdx) | ✅ | The event type | \ No newline at end of file diff --git a/docs/components/imagemodelarchitecture.mdx b/docs/components/imagemodelarchitecture.mdx index 860b66299..1c86917c8 100644 --- a/docs/components/imagemodelarchitecture.mdx +++ b/docs/components/imagemodelarchitecture.mdx @@ -6,5 +6,5 @@ title: "ImageModelArchitecture" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `input_modalities` | List[[components.ImageInputModality](../components/imageinputmodality.mdx)] | :heavy_check_mark: | Supported input modalities | -| `output_modalities` | List[[components.ImageOutputModality](../components/imageoutputmodality.mdx)] | :heavy_check_mark: | Supported output modalities | \ No newline at end of file +| `input_modalities` | List[[components.ImageInputModality](../components/imageinputmodality.mdx)] | ✅ | Supported input modalities | +| `output_modalities` | List[[components.ImageOutputModality](../components/imageoutputmodality.mdx)] | ✅ | Supported output modalities | \ No newline at end of file diff --git a/docs/components/imagemodelendpointsresponse.mdx b/docs/components/imagemodelendpointsresponse.mdx index 7d3ec9ccf..dd3d632a7 100644 --- a/docs/components/imagemodelendpointsresponse.mdx +++ b/docs/components/imagemodelendpointsresponse.mdx @@ -9,5 +9,5 @@ The full per-endpoint records for an image model. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `endpoints` | List[[components.ImageEndpoint](../components/imageendpoint.mdx)] | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file +| `endpoints` | List[[components.ImageEndpoint](../components/imageendpoint.mdx)] | ✅ | N/A | | +| `id` | *str* | ✅ | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file diff --git a/docs/components/imagemodellistitem.mdx b/docs/components/imagemodellistitem.mdx index 633c99be2..e6a900bcb 100644 --- a/docs/components/imagemodellistitem.mdx +++ b/docs/components/imagemodellistitem.mdx @@ -9,11 +9,11 @@ A single image model in the discovery listing. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [components.ImageModelArchitecture](../components/imagemodelarchitecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | -| `created` | *int* | :heavy_check_mark: | Unix timestamp (seconds) of when the model was created | 1692901234 | -| `description` | *str* | :heavy_check_mark: | N/A | A text-to-image model. | -| `endpoints` | *str* | :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` | *str* | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | -| `name` | *str* | :heavy_check_mark: | Display name | Seedream 4.5 | -| `supported_parameters` | Dict[str, [components.CapabilityDescriptor](../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"
}
} | -| `supports_streaming` | *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](../components/imagemodelarchitecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | +| `created` | *int* | ✅ | Unix timestamp (seconds) of when the model was created | 1692901234 | +| `description` | *str* | ✅ | N/A | A text-to-image model. | +| `endpoints` | *str* | ✅ | Relative URL to the full per-endpoint records for this model | /api/v1/images/models/bytedance-seed/seedream-4.5/endpoints | +| `id` | *str* | ✅ | Model slug | bytedance-seed/seedream-4.5 | +| `name` | *str* | ✅ | Display name | Seedream 4.5 | +| `supported_parameters` | Dict[str, [components.CapabilityDescriptor](../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"
}
} | +| `supports_streaming` | *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/components/imagemodelslistresponse.mdx b/docs/components/imagemodelslistresponse.mdx index b5d695bd1..545dcf6bf 100644 --- a/docs/components/imagemodelslistresponse.mdx +++ b/docs/components/imagemodelslistresponse.mdx @@ -9,4 +9,4 @@ List of image generation models. | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `data` | List[[components.ImageModelListItem](../components/imagemodellistitem.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.ImageModelListItem](../components/imagemodellistitem.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/imagepricingentry.mdx b/docs/components/imagepricingentry.mdx index 8381e7e71..5a774b9ee 100644 --- a/docs/components/imagepricingentry.mdx +++ b/docs/components/imagepricingentry.mdx @@ -9,7 +9,7 @@ One billable pricing line for an image provider. | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `billable` | [components.Billable](../components/billable.mdx) | :heavy_check_mark: | N/A | -| `cost_usd` | *float* | :heavy_check_mark: | N/A | -| `unit` | [components.Unit](../components/unit.mdx) | :heavy_check_mark: | N/A | -| `variant` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `billable` | [components.Billable](../components/billable.mdx) | ✅ | N/A | +| `cost_usd` | *float* | ✅ | N/A | +| `unit` | [components.Unit](../components/unit.mdx) | ✅ | N/A | +| `variant` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/imagestreamingresponse.mdx b/docs/components/imagestreamingresponse.mdx index 8aad6cc34..7274b1f69 100644 --- a/docs/components/imagestreamingresponse.mdx +++ b/docs/components/imagestreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ImageStreamingResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `data` | [components.ImageStreamingResponseData](../components/imagestreamingresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.ImageStreamingResponseData](../components/imagestreamingresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/incompletedetails.mdx b/docs/components/incompletedetails.mdx index 33c9c9317..0cb88a681 100644 --- a/docs/components/incompletedetails.mdx +++ b/docs/components/incompletedetails.mdx @@ -6,4 +6,4 @@ title: "IncompleteDetails" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `reason` | [Optional[components.IncompleteDetailsReason]](../components/incompletedetailsreason.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `reason` | [Optional[components.IncompleteDetailsReason]](../components/incompletedetailsreason.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/input1.mdx b/docs/components/input1.mdx index 43245bc10..dc88a4bb7 100644 --- a/docs/components/input1.mdx +++ b/docs/components/input1.mdx @@ -6,4 +6,4 @@ title: "Input1" | Field | Type | Required | Description | Example | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `prompt` | *str* | :heavy_check_mark: | N/A | What is the meaning of life? | \ No newline at end of file +| `prompt` | *str* | ✅ | N/A | What is the meaning of life? | \ No newline at end of file diff --git a/docs/components/input2.mdx b/docs/components/input2.mdx index 8ff9ce181..0f37fdb22 100644 --- a/docs/components/input2.mdx +++ b/docs/components/input2.mdx @@ -6,4 +6,4 @@ title: "Input2" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `messages` | List[*Any*] | :heavy_check_mark: | N/A | [
\{
"content": "What is the meaning of life?",
"role": "user"
}
] | \ No newline at end of file +| `messages` | List[*Any*] | ✅ | N/A | [
\{
"content": "What is the meaning of life?",
"role": "user"
}
] | \ No newline at end of file diff --git a/docs/components/inputaudio.mdx b/docs/components/inputaudio.mdx index 54aba1db8..02d932037 100644 --- a/docs/components/inputaudio.mdx +++ b/docs/components/inputaudio.mdx @@ -9,5 +9,5 @@ Audio input content item | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `input_audio` | [components.InputAudioInputAudio](../components/inputaudioinputaudio.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.InputAudioType](../components/inputaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `input_audio` | [components.InputAudioInputAudio](../components/inputaudioinputaudio.mdx) | ✅ | N/A | +| `type` | [components.InputAudioType](../components/inputaudiotype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/inputaudioinputaudio.mdx b/docs/components/inputaudioinputaudio.mdx index 29ec9c922..a625bd45c 100644 --- a/docs/components/inputaudioinputaudio.mdx +++ b/docs/components/inputaudioinputaudio.mdx @@ -6,5 +6,5 @@ title: "InputAudioInputAudio" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | -| `format_` | [components.FormatEnum](../components/formatenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *str* | ✅ | N/A | +| `format_` | [components.FormatEnum](../components/formatenum.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/inputfile.mdx b/docs/components/inputfile.mdx index 2e4a15d5c..07a5d8f38 100644 --- a/docs/components/inputfile.mdx +++ b/docs/components/inputfile.mdx @@ -9,8 +9,8 @@ File input content item | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `file_data` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `file_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `filename` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.InputFileType](../components/inputfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file_data` | *Optional[str]* | ➖ | N/A | +| `file_id` | *OptionalNullable[str]* | ➖ | N/A | +| `file_url` | *Optional[str]* | ➖ | N/A | +| `filename` | *Optional[str]* | ➖ | N/A | +| `type` | [components.InputFileType](../components/inputfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/inputimage.mdx b/docs/components/inputimage.mdx index c4b373901..0fe16f7b0 100644 --- a/docs/components/inputimage.mdx +++ b/docs/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](../components/inputimagedetail.mdx) | :heavy_check_mark: | N/A | -| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.InputImageType](../components/inputimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [components.InputImageDetail](../components/inputimagedetail.mdx) | ✅ | N/A | +| `file_id` | *OptionalNullable[str]* | ➖ | N/A | +| `image_url` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.InputImageType](../components/inputimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/inputimagemask.mdx b/docs/components/inputimagemask.mdx index 74ce00775..2092337ea 100644 --- a/docs/components/inputimagemask.mdx +++ b/docs/components/inputimagemask.mdx @@ -6,5 +6,5 @@ title: "InputImageMask" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `file_id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `file_id` | *Optional[str]* | ➖ | N/A | +| `image_url` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/inputmessageitem.mdx b/docs/components/inputmessageitem.mdx index 0a2f6e5d2..f1fed10b2 100644 --- a/docs/components/inputmessageitem.mdx +++ b/docs/components/inputmessageitem.mdx @@ -6,7 +6,7 @@ title: "InputMessageItem" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `content` | List[[components.InputMessageItemContentUnion](../components/inputmessageitemcontentunion.mdx)] | :heavy_minus_sign: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `role` | [components.InputMessageItemRoleUnion](../components/inputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | -| `type` | [Optional[components.InputMessageItemTypeMessage]](../components/inputmessageitemtypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | List[[components.InputMessageItemContentUnion](../components/inputmessageitemcontentunion.mdx)] | ➖ | N/A | +| `id` | *Optional[str]* | ➖ | N/A | +| `role` | [components.InputMessageItemRoleUnion](../components/inputmessageitemroleunion.mdx) | ✅ | N/A | +| `type` | [Optional[components.InputMessageItemTypeMessage]](../components/inputmessageitemtypemessage.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/inputmessageitemcontentinputimage.mdx b/docs/components/inputmessageitemcontentinputimage.mdx index 6c503806b..27a6f7fe6 100644 --- a/docs/components/inputmessageitemcontentinputimage.mdx +++ b/docs/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](../components/inputmessageitemdetail.mdx) | :heavy_check_mark: | N/A | -| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.InputMessageItemTypeInputImage](../components/inputmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [components.InputMessageItemDetail](../components/inputmessageitemdetail.mdx) | ✅ | N/A | +| `file_id` | *OptionalNullable[str]* | ➖ | N/A | +| `image_url` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.InputMessageItemTypeInputImage](../components/inputmessageitemtypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/inputschema.mdx b/docs/components/inputschema.mdx index c86a4f23d..85c82024c 100644 --- a/docs/components/inputschema.mdx +++ b/docs/components/inputschema.mdx @@ -6,7 +6,7 @@ title: "InputSchema" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `properties` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `required` | List[*str*] | :heavy_minus_sign: | N/A | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `properties` | *Optional[Any]* | ➖ | N/A | +| `required` | List[*str*] | ➖ | N/A | +| `type` | *Optional[str]* | ➖ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/inputsmessage.mdx b/docs/components/inputsmessage.mdx index f64aa8de6..9b45ed32f 100644 --- a/docs/components/inputsmessage.mdx +++ b/docs/components/inputsmessage.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [Nullable[components.InputsContent2]](../components/inputscontent2.mdx) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `phase` | [OptionalNullable[components.InputsPhaseUnion]](../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](../components/inputsrole.mdx) | :heavy_check_mark: | N/A | -| `status` | [Optional[components.InputsStatusUnion1]](../components/inputsstatusunion1.mdx) | :heavy_minus_sign: | N/A | -| `type` | [Optional[components.InputsTypeMessage]](../components/inputstypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | [Nullable[components.InputsContent2]](../components/inputscontent2.mdx) | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `phase` | [OptionalNullable[components.InputsPhaseUnion]](../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](../components/inputsrole.mdx) | ✅ | N/A | +| `status` | [Optional[components.InputsStatusUnion1]](../components/inputsstatusunion1.mdx) | ➖ | N/A | +| `type` | [Optional[components.InputsTypeMessage]](../components/inputstypemessage.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/inputsreasoning.mdx b/docs/components/inputsreasoning.mdx index 60e9a1a60..ecd382f46 100644 --- a/docs/components/inputsreasoning.mdx +++ b/docs/components/inputsreasoning.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [Optional[components.InputsStatusUnion2]](../components/inputsstatusunion2.mdx) | :heavy_minus_sign: | N/A | | -| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | :heavy_check_mark: | N/A | | -| `type` | [components.InputsTypeReasoning](../components/inputstypereasoning.mdx) | :heavy_check_mark: | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | ➖ | N/A | | +| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `status` | [Optional[components.InputsStatusUnion2]](../components/inputsstatusunion2.mdx) | ➖ | N/A | | +| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | ✅ | N/A | | +| `type` | [components.InputsTypeReasoning](../components/inputstypereasoning.mdx) | ✅ | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | +| `signature` | *OptionalNullable[str]* | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/components/inputtext.mdx b/docs/components/inputtext.mdx index 590841308..cf4c5888a 100644 --- a/docs/components/inputtext.mdx +++ b/docs/components/inputtext.mdx @@ -9,6 +9,6 @@ Text input content item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `prompt_cache_breakpoint` | [OptionalNullable[components.PromptCacheBreakpoint]](../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` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.InputTextType](../components/inputtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `prompt_cache_breakpoint` | [OptionalNullable[components.PromptCacheBreakpoint]](../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` | *str* | ✅ | N/A | | +| `type` | [components.InputTextType](../components/inputtexttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/inputtokensdetails.mdx b/docs/components/inputtokensdetails.mdx index daa531b4e..0b1d333f6 100644 --- a/docs/components/inputtokensdetails.mdx +++ b/docs/components/inputtokensdetails.mdx @@ -6,5 +6,5 @@ title: "InputTokensDetails" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `cache_write_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `cached_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `cache_write_tokens` | *OptionalNullable[int]* | ➖ | N/A | +| `cached_tokens` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/inputvideo.mdx b/docs/components/inputvideo.mdx index c7e3967e6..ba5fa2253 100644 --- a/docs/components/inputvideo.mdx +++ b/docs/components/inputvideo.mdx @@ -9,6 +9,6 @@ Video input content item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `processing` | [Optional[components.InputVideoProcessing]](../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](../components/inputvideotype.mdx) | :heavy_check_mark: | N/A | | -| `video_url` | *str* | :heavy_check_mark: | A base64 data URL or remote URL that resolves to a video file | | \ No newline at end of file +| `processing` | [Optional[components.InputVideoProcessing]](../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](../components/inputvideotype.mdx) | ✅ | N/A | | +| `video_url` | *str* | ✅ | A base64 data URL or remote URL that resolves to a video file | | \ No newline at end of file diff --git a/docs/components/intern.mdx b/docs/components/intern.mdx index 71f5da0f9..d7a6f76e2 100644 --- a/docs/components/intern.mdx +++ b/docs/components/intern.mdx @@ -9,17 +9,17 @@ Public lifecycle state and settings for one intern. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `attached_vault_id` | *Nullable[str]* | :heavy_check_mark: | Vault the intern borrows from another intern, or null when it borrows none. | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 creation time. | -| `description` | *Nullable[str]* | :heavy_check_mark: | Free-form description. | -| `hostname` | *Nullable[str]* | :heavy_check_mark: | Public hostname the intern is reachable at, or null until provisioning has assigned one. | -| `id` | *str* | :heavy_check_mark: | Intern id. | -| `instructions` | *Nullable[str]* | :heavy_check_mark: | Standing instructions the intern boots with. | -| `last_failure_message` | *Nullable[str]* | :heavy_check_mark: | Why the last provisioning attempt failed, when status is failed. | -| `model` | *Nullable[str]* | :heavy_check_mark: | OpenRouter model slug the intern runs, or null for the workspace default. | -| `name` | *str* | :heavy_check_mark: | Intern name, unique per creator within a workspace. | -| `progress` | [Nullable[components.Progress]](../components/progress.mdx) | :heavy_check_mark: | Active provisioning step, or null once provisioning has settled. | -| `status` | [components.InternStatus](../components/internstatus.mdx) | :heavy_check_mark: | Lifecycle status. | -| `updated_at` | *str* | :heavy_check_mark: | ISO 8601 last update time. | -| `vault_id` | *Nullable[str]* | :heavy_check_mark: | Vault the intern owns, or null before it has been created. | -| `workspace_id` | *str* | :heavy_check_mark: | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file +| `attached_vault_id` | *Nullable[str]* | ✅ | Vault the intern borrows from another intern, or null when it borrows none. | +| `created_at` | *str* | ✅ | ISO 8601 creation time. | +| `description` | *Nullable[str]* | ✅ | Free-form description. | +| `hostname` | *Nullable[str]* | ✅ | Public hostname the intern is reachable at, or null until provisioning has assigned one. | +| `id` | *str* | ✅ | Intern id. | +| `instructions` | *Nullable[str]* | ✅ | Standing instructions the intern boots with. | +| `last_failure_message` | *Nullable[str]* | ✅ | Why the last provisioning attempt failed, when status is failed. | +| `model` | *Nullable[str]* | ✅ | OpenRouter model slug the intern runs, or null for the workspace default. | +| `name` | *str* | ✅ | Intern name, unique per creator within a workspace. | +| `progress` | [Nullable[components.Progress]](../components/progress.mdx) | ✅ | Active provisioning step, or null once provisioning has settled. | +| `status` | [components.InternStatus](../components/internstatus.mdx) | ✅ | Lifecycle status. | +| `updated_at` | *str* | ✅ | ISO 8601 last update time. | +| `vault_id` | *Nullable[str]* | ✅ | Vault the intern owns, or null before it has been created. | +| `workspace_id` | *str* | ✅ | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file diff --git a/docs/components/internalserverresponseerrordata.mdx b/docs/components/internalserverresponseerrordata.mdx index 8ddf14e86..11ab52ab0 100644 --- a/docs/components/internalserverresponseerrordata.mdx +++ b/docs/components/internalserverresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for InternalServerResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/internchatassistantmessage.mdx b/docs/components/internchatassistantmessage.mdx index 3334fd334..f28152771 100644 --- a/docs/components/internchatassistantmessage.mdx +++ b/docs/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[components.InternChatMessageContent]](../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](../components/internchatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `tool_calls` | List[[components.InternChatEchoedToolCall](../components/internchatechoedtoolcall.mdx)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `content` | [OptionalNullable[components.InternChatMessageContent]](../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](../components/internchatassistantmessagerole.mdx) | ✅ | N/A | | +| `tool_calls` | List[[components.InternChatEchoedToolCall](../components/internchatechoedtoolcall.mdx)] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/internchatchoice.mdx b/docs/components/internchatchoice.mdx index 7d0bdde08..4ae3de477 100644 --- a/docs/components/internchatchoice.mdx +++ b/docs/components/internchatchoice.mdx @@ -9,6 +9,6 @@ The single choice this endpoint streams. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `delta` | [components.InternChatDelta](../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"
} | -| `finish_reason` | [Nullable[components.InternChatChoiceFinishReason]](../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` | *int* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `delta` | [components.InternChatDelta](../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"
} | +| `finish_reason` | [Nullable[components.InternChatChoiceFinishReason]](../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` | *int* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/internchatcompletionchunk.mdx b/docs/components/internchatcompletionchunk.mdx index 9f35a80a9..49dd63e5e 100644 --- a/docs/components/internchatcompletionchunk.mdx +++ b/docs/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` | List[[components.InternChatChoice](../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` | *int* | :heavy_check_mark: | N/A | | -| `error` | [Optional[components.InternChatStreamError]](../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` | *str* | :heavy_check_mark: | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | -| `model` | *str* | :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](../components/internchatcompletionchunkobject.mdx) | :heavy_check_mark: | N/A | | -| `session_id` | *OptionalNullable[str]* | :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[components.InternChatUsage]](../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` | List[[components.InternChatChoice](../components/internchatchoice.mdx)] | ✅ | One choice on content, tool-call and error chunks. Empty on the final chunk that carries `session_id`. | | +| `created` | *int* | ✅ | N/A | | +| `error` | [Optional[components.InternChatStreamError]](../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` | *str* | ✅ | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | +| `model` | *str* | ✅ | 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](../components/internchatcompletionchunkobject.mdx) | ✅ | N/A | | +| `session_id` | *OptionalNullable[str]* | ➖ | 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[components.InternChatUsage]](../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/components/internchatcompletionrequest.mdx b/docs/components/internchatcompletionrequest.mdx index ea77f21bc..26a29d7b9 100644 --- a/docs/components/internchatcompletionrequest.mdx +++ b/docs/components/internchatcompletionrequest.mdx @@ -9,8 +9,8 @@ An OpenAI-compatible streaming chat completion request for one intern. Other Ope | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `approval_mode` | [Optional[components.InternApprovalMode]](../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` | List[[components.InternChatMessage](../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` | *Optional[str]* | :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 | -| `session_id` | *Optional[str]* | :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` | *Literal[True]* | :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 +| `approval_mode` | [Optional[components.InternApprovalMode]](../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` | List[[components.InternChatMessage](../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` | *Optional[str]* | ➖ | 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 | +| `session_id` | *Optional[str]* | ➖ | 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` | *Literal[True]* | ✅ | 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/components/internchatdelta.mdx b/docs/components/internchatdelta.mdx index 950f73d45..62b50f774 100644 --- a/docs/components/internchatdelta.mdx +++ b/docs/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` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `reasoning` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `role` | [Optional[components.InternChatDeltaRole]](../components/internchatdeltarole.mdx) | :heavy_minus_sign: | N/A | -| `tool_calls` | List[[components.InternChatToolCall](../components/internchattoolcall.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | *Optional[str]* | ➖ | N/A | +| `reasoning` | *Optional[str]* | ➖ | N/A | +| `role` | [Optional[components.InternChatDeltaRole]](../components/internchatdeltarole.mdx) | ➖ | N/A | +| `tool_calls` | List[[components.InternChatToolCall](../components/internchattoolcall.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/internchatdevelopermessage.mdx b/docs/components/internchatdevelopermessage.mdx index 0fd5f0fbf..9c2f8fa14 100644 --- a/docs/components/internchatdevelopermessage.mdx +++ b/docs/components/internchatdevelopermessage.mdx @@ -9,5 +9,5 @@ A developer message. Accepted for client compatibility and not forwarded. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatdevelopermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatdevelopermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/internchatechoedtoolcall.mdx b/docs/components/internchatechoedtoolcall.mdx index a869fcac2..4daf2bb5e 100644 --- a/docs/components/internchatechoedtoolcall.mdx +++ b/docs/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](../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` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `function` | [components.InternChatEchoedToolCallFunction](../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` | *str* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/internchatechoedtoolcallfunction.mdx b/docs/components/internchatechoedtoolcallfunction.mdx index 7b057bd6a..a8a640eeb 100644 --- a/docs/components/internchatechoedtoolcallfunction.mdx +++ b/docs/components/internchatechoedtoolcallfunction.mdx @@ -9,5 +9,5 @@ The function name and JSON arguments string exactly as streamed. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | +| `name` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/internchaterror.mdx b/docs/components/internchaterror.mdx index 84af96295..288e1147c 100644 --- a/docs/components/internchaterror.mdx +++ b/docs/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` | *int* | :heavy_check_mark: | The HTTP status of the response. | | -| `message` | *str* | :heavy_check_mark: | N/A | | -| `metadata` | [Optional[components.InternChatErrorMetadata]](../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` | *int* | ✅ | The HTTP status of the response. | | +| `message` | *str* | ✅ | N/A | | +| `metadata` | [Optional[components.InternChatErrorMetadata]](../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/components/internchaterrormetadata.mdx b/docs/components/internchaterrormetadata.mdx index 0e5c6b605..19b1afb7b 100644 --- a/docs/components/internchaterrormetadata.mdx +++ b/docs/components/internchaterrormetadata.mdx @@ -9,5 +9,5 @@ Machine-readable detail for the failure. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `reason` | [components.InternChatErrorMetadataReason](../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](../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/components/internchatprompttokensdetails.mdx b/docs/components/internchatprompttokensdetails.mdx index 77b2e3417..2aab9333f 100644 --- a/docs/components/internchatprompttokensdetails.mdx +++ b/docs/components/internchatprompttokensdetails.mdx @@ -9,4 +9,4 @@ Prompt tokens served from cache, when the daemon reported them. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `cached_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `cached_tokens` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/internchatsteeredresponse.mdx b/docs/components/internchatsteeredresponse.mdx index 51fdf7178..44a8a6b0c 100644 --- a/docs/components/internchatsteeredresponse.mdx +++ b/docs/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 | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `session_id` | *str* | :heavy_check_mark: | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | -| `status` | [components.InternChatSteeredResponseStatus](../components/internchatsteeredresponsestatus.mdx) | :heavy_check_mark: | The message was handed to the turn already running on this session. | | \ No newline at end of file +| `session_id` | *str* | ✅ | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | +| `status` | [components.InternChatSteeredResponseStatus](../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/components/internchatstreamerror.mdx b/docs/components/internchatstreamerror.mdx index b19200571..f6abede1c 100644 --- a/docs/components/internchatstreamerror.mdx +++ b/docs/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` | *int* | :heavy_check_mark: | The HTTP status this failure would have had before the stream opened. | | -| `message` | *str* | :heavy_check_mark: | N/A | | -| `metadata` | [components.InternChatErrorMetadata](../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` | *int* | ✅ | The HTTP status this failure would have had before the stream opened. | | +| `message` | *str* | ✅ | N/A | | +| `metadata` | [components.InternChatErrorMetadata](../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/components/internchatstreamingresponse.mdx b/docs/components/internchatstreamingresponse.mdx index 04ad18b61..496aa77ff 100644 --- a/docs/components/internchatstreamingresponse.mdx +++ b/docs/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](../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](../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/components/internchatsystemmessage.mdx b/docs/components/internchatsystemmessage.mdx index d45683415..7c5aa907c 100644 --- a/docs/components/internchatsystemmessage.mdx +++ b/docs/components/internchatsystemmessage.mdx @@ -9,5 +9,5 @@ A system message. Accepted for client compatibility and not forwarded. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatsystemmessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatsystemmessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/internchattextpart.mdx b/docs/components/internchattextpart.mdx index 0bd3a5dc9..239809409 100644 --- a/docs/components/internchattextpart.mdx +++ b/docs/components/internchattextpart.mdx @@ -9,5 +9,5 @@ One text part of a message. | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.InternChatTextPartType](../components/internchattextparttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *str* | ✅ | N/A | +| `type` | [components.InternChatTextPartType](../components/internchattextparttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/internchattoolcall.mdx b/docs/components/internchattoolcall.mdx index 6176afe83..082d06ac4 100644 --- a/docs/components/internchattoolcall.mdx +++ b/docs/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](../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` | *str* | :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` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.InternChatToolCallType](../components/internchattoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `function` | [components.InternChatToolCallFunction](../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` | *str* | ✅ | The interaction id. Send it back as `tool_call_id` on the `tool` message that answers it. | 15e90ad6-5320-4a59-af4f-b371428154fa | +| `index` | *int* | ✅ | N/A | | +| `type` | [components.InternChatToolCallType](../components/internchattoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/internchattoolcallfunction.mdx b/docs/components/internchattoolcallfunction.mdx index 918fa0b27..fd934b305 100644 --- a/docs/components/internchattoolcallfunction.mdx +++ b/docs/components/internchattoolcallfunction.mdx @@ -9,5 +9,5 @@ The single tool this endpoint calls, asking the caller for input. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | :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](../components/internchattoolcallfunctionname.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *str* | ✅ | 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](../components/internchattoolcallfunctionname.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/internchattoolmessage.mdx b/docs/components/internchattoolmessage.mdx index f2673d01f..6a80386bb 100644 --- a/docs/components/internchattoolmessage.mdx +++ b/docs/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` | [Nullable[components.InternChatMessageContent]](../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](../components/internchattoolmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `tool_call_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchattoolmessagerole.mdx) | ✅ | N/A | | +| `tool_call_id` | *str* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/internchatusage.mdx b/docs/components/internchatusage.mdx index 221095cfd..7d4ea67d4 100644 --- a/docs/components/internchatusage.mdx +++ b/docs/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 | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `completion_tokens` | *int* | :heavy_check_mark: | N/A | | -| `cost` | *Optional[float]* | :heavy_minus_sign: | The cost of the run in USD, when the daemon reported one. | | -| `prompt_tokens` | *int* | :heavy_check_mark: | N/A | | -| `prompt_tokens_details` | [Optional[components.InternChatPromptTokensDetails]](../components/internchatprompttokensdetails.mdx) | :heavy_minus_sign: | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | -| `total_tokens` | *int* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `completion_tokens` | *int* | ✅ | N/A | | +| `cost` | *Optional[float]* | ➖ | The cost of the run in USD, when the daemon reported one. | | +| `prompt_tokens` | *int* | ✅ | N/A | | +| `prompt_tokens_details` | [Optional[components.InternChatPromptTokensDetails]](../components/internchatprompttokensdetails.mdx) | ➖ | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | +| `total_tokens` | *int* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/internchatusermessage.mdx b/docs/components/internchatusermessage.mdx index 55aae5818..22469972a 100644 --- a/docs/components/internchatusermessage.mdx +++ b/docs/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` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatusermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [Nullable[components.InternChatMessageContent]](../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](../components/internchatusermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/interndaemonaccess.mdx b/docs/components/interndaemonaccess.mdx index 7a564fb42..4bf141df9 100644 --- a/docs/components/interndaemonaccess.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `origin` | *str* | ✅ | N/A | +| `token` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/interninvokeacceptedresponse.mdx b/docs/components/interninvokeacceptedresponse.mdx index bcec63f8d..cf0a574a8 100644 --- a/docs/components/interninvokeacceptedresponse.mdx +++ b/docs/components/interninvokeacceptedresponse.mdx @@ -9,5 +9,5 @@ The intern admitted the prompt. The run continues on the intern. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `session_id` | *str* | :heavy_check_mark: | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | -| `status` | [components.InternInvokeAcceptedResponseStatus](../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 +| `session_id` | *str* | ✅ | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | +| `status` | [components.InternInvokeAcceptedResponseStatus](../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/components/interninvokerequest.mdx b/docs/components/interninvokerequest.mdx index 01ec56d1b..8f1fdf4ac 100644 --- a/docs/components/interninvokerequest.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | -| `session_id` | *Optional[str]* | :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` | *str* | ✅ | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | +| `session_id` | *Optional[str]* | ➖ | 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/components/internlifecycleerrorerror.mdx b/docs/components/internlifecycleerrorerror.mdx index dc3a8f402..f4cfd7cb4 100644 --- a/docs/components/internlifecycleerrorerror.mdx +++ b/docs/components/internlifecycleerrorerror.mdx @@ -6,6 +6,6 @@ title: "InternLifecycleErrorError" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `code` | [components.Code](../components/code.mdx) | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | [Optional[components.InternLifecycleErrorMetadata]](../components/internlifecycleerrormetadata.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | [components.Code](../components/code.mdx) | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | [Optional[components.InternLifecycleErrorMetadata]](../components/internlifecycleerrormetadata.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/internlifecycleerrormetadata.mdx b/docs/components/internlifecycleerrormetadata.mdx index f0f458162..e699b3cdb 100644 --- a/docs/components/internlifecycleerrormetadata.mdx +++ b/docs/components/internlifecycleerrormetadata.mdx @@ -6,5 +6,5 @@ title: "InternLifecycleErrorMetadata" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `reason` | *str* | :heavy_check_mark: | N/A | -| `retryable` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file +| `reason` | *str* | ✅ | N/A | +| `retryable` | *bool* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/internlistresponse.mdx b/docs/components/internlistresponse.mdx index 75702eed1..ad1d23db6 100644 --- a/docs/components/internlistresponse.mdx +++ b/docs/components/internlistresponse.mdx @@ -9,6 +9,6 @@ Interns visible to the authenticated API key. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | List[[components.Intern](../components/intern.mdx)] | :heavy_check_mark: | N/A | | -| `has_more` | *bool* | :heavy_check_mark: | True when more interns match the current filters. | | -| `next_cursor` | *Optional[str]* | :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` | List[[components.Intern](../components/intern.mdx)] | ✅ | N/A | | +| `has_more` | *bool* | ✅ | True when more interns match the current filters. | | +| `next_cursor` | *Optional[str]* | ➖ | 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/components/itemreferenceitem.mdx b/docs/components/itemreferenceitem.mdx index 5d91c205a..db89ad466 100644 --- a/docs/components/itemreferenceitem.mdx +++ b/docs/components/itemreferenceitem.mdx @@ -9,5 +9,5 @@ A reference to a previous response item by ID | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ItemReferenceItemType](../components/itemreferenceitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `id` | *str* | ✅ | N/A | +| `type` | [components.ItemReferenceItemType](../components/itemreferenceitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/jevrouterplugin.mdx b/docs/components/jevrouterplugin.mdx index 5cd6cbcf4..c56d97b12 100644 --- a/docs/components/jevrouterplugin.mdx +++ b/docs/components/jevrouterplugin.mdx @@ -6,8 +6,8 @@ title: "JevRouterPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | -| `cost_tier` | *Optional[str]* | :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 | -| `excluded_models` | List[*str*] | :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](../components/jevrouterpluginid.mdx) | :heavy_check_mark: | N/A | | -| `models` | List[*str*] | :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 +| `allowed_models` | List[*str*] | ➖ | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | +| `cost_tier` | *Optional[str]* | ➖ | 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 | +| `excluded_models` | List[*str*] | ➖ | 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](../components/jevrouterpluginid.mdx) | ✅ | N/A | | +| `models` | List[*str*] | ➖ | 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/components/keepall.mdx b/docs/components/keepall.mdx index 8f65526d9..2e0dfaa8b 100644 --- a/docs/components/keepall.mdx +++ b/docs/components/keepall.mdx @@ -6,4 +6,4 @@ title: "KeepAll" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | [components.KeepType](../components/keeptype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.KeepType](../components/keeptype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/key.mdx b/docs/components/key.mdx index 48c2e0831..250d73b32 100644 --- a/docs/components/key.mdx +++ b/docs/components/key.mdx @@ -6,10 +6,10 @@ title: "Key" | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `alg` | [components.Alg](../components/alg.mdx) | :heavy_check_mark: | N/A | -| `crv` | [components.Crv](../components/crv.mdx) | :heavy_check_mark: | N/A | -| `kid` | *str* | :heavy_check_mark: | N/A | -| `kty` | [components.Kty](../components/kty.mdx) | :heavy_check_mark: | N/A | -| `use` | [components.Use](../components/use.mdx) | :heavy_check_mark: | N/A | -| `x` | *str* | :heavy_check_mark: | N/A | -| `y` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `alg` | [components.Alg](../components/alg.mdx) | ✅ | N/A | +| `crv` | [components.Crv](../components/crv.mdx) | ✅ | N/A | +| `kid` | *str* | ✅ | N/A | +| `kty` | [components.Kty](../components/kty.mdx) | ✅ | N/A | +| `use` | [components.Use](../components/use.mdx) | ✅ | N/A | +| `x` | *str* | ✅ | N/A | +| `y` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/keyassignment.mdx b/docs/components/keyassignment.mdx index 3c18ed0fb..67ed953d3 100644 --- a/docs/components/keyassignment.mdx +++ b/docs/components/keyassignment.mdx @@ -6,10 +6,10 @@ title: "KeyAssignment" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hash` | *str* | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `key_label` | *str* | :heavy_check_mark: | Label of the API key | prod-key | -| `key_name` | *str* | :heavy_check_mark: | Name of the API key | Production Key | \ No newline at end of file +| `assigned_by` | *Nullable[str]* | ✅ | User ID of who made the assignment | user_abc123 | +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `guardrail_id` | *str* | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `id` | *str* | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `key_hash` | *str* | ✅ | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | +| `key_label` | *str* | ✅ | Label of the API key | prod-key | +| `key_name` | *str* | ✅ | Name of the API key | Production Key | \ No newline at end of file diff --git a/docs/components/keybudget.mdx b/docs/components/keybudget.mdx index e32f03c45..19924410b 100644 --- a/docs/components/keybudget.mdx +++ b/docs/components/keybudget.mdx @@ -9,12 +9,12 @@ One budget layer that applies to requests made with this key, with the spend enf | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `budget_id` | *Nullable[str]* | :heavy_check_mark: | ID of the workspace budget for the `workspace` scope; null for other scopes. | null | -| `guardrail_id` | *Nullable[str]* | :heavy_check_mark: | ID of the guardrail that carries this budget; null for other scopes. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `include_byok` | *bool* | :heavy_check_mark: | Whether external BYOK inference spend counts toward this budget. | false | -| `limit_usd` | *float* | :heavy_check_mark: | Budget limit in USD for the current window. | 50 | -| `remaining_usd` | *float* | :heavy_check_mark: | `limit_usd - spend_usd`. Zero or negative means this layer rejects requests with a 403 until it resets. | 17.5 | -| `reset_interval` | [Nullable[components.KeyBudgetResetInterval]](../components/keybudgetresetinterval.mdx) | :heavy_check_mark: | UTC window the spend is counted over (weeks start Monday); null for a lifetime budget that never resets. | weekly | -| `resets_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | ISO 8601 UTC instant at which the window rolls over and spend returns to zero; null for a lifetime budget. | 2026-10-12T00:00:00.000Z | -| `scope` | [components.KeyBudgetScope](../components/keybudgetscope.mdx) | :heavy_check_mark: | Which budget layer this is, in the order enforcement checks them: the workspace default guardrail against the member aggregate (`workspace_default_member`) and against this key (`workspace_default_key`), the member guardrail (`member`), the API key guardrail (`api_key`), a workspace budget (`workspace`), or the key's own limit (`key_limit`). | member | -| `spend_usd` | *float* | :heavy_check_mark: | Spend in USD that enforcement counts against this limit in the current window: the member aggregate for member-scoped layers, otherwise this key or workspace. | 32.5 | \ No newline at end of file +| `budget_id` | *Nullable[str]* | ✅ | ID of the workspace budget for the `workspace` scope; null for other scopes. | null | +| `guardrail_id` | *Nullable[str]* | ✅ | ID of the guardrail that carries this budget; null for other scopes. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `include_byok` | *bool* | ✅ | Whether external BYOK inference spend counts toward this budget. | false | +| `limit_usd` | *float* | ✅ | Budget limit in USD for the current window. | 50 | +| `remaining_usd` | *float* | ✅ | `limit_usd - spend_usd`. Zero or negative means this layer rejects requests with a 403 until it resets. | 17.5 | +| `reset_interval` | [Nullable[components.KeyBudgetResetInterval]](../components/keybudgetresetinterval.mdx) | ✅ | UTC window the spend is counted over (weeks start Monday); null for a lifetime budget that never resets. | weekly | +| `resets_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | ISO 8601 UTC instant at which the window rolls over and spend returns to zero; null for a lifetime budget. | 2026-10-12T00:00:00.000Z | +| `scope` | [components.KeyBudgetScope](../components/keybudgetscope.mdx) | ✅ | Which budget layer this is, in the order enforcement checks them: the workspace default guardrail against the member aggregate (`workspace_default_member`) and against this key (`workspace_default_key`), the member guardrail (`member`), the API key guardrail (`api_key`), a workspace budget (`workspace`), or the key's own limit (`key_limit`). | member | +| `spend_usd` | *float* | ✅ | Spend in USD that enforcement counts against this limit in the current window: the member aggregate for member-scoped layers, otherwise this key or workspace. | 32.5 | \ No newline at end of file diff --git a/docs/components/legacychatcontentvideo.mdx b/docs/components/legacychatcontentvideo.mdx index 74b480b1c..7affafef7 100644 --- a/docs/components/legacychatcontentvideo.mdx +++ b/docs/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](../components/legacychatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | -| `video_url` | [components.LegacyChatContentVideoInput](../components/legacychatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `type` | [components.LegacyChatContentVideoType](../components/legacychatcontentvideotype.mdx) | ✅ | N/A | | +| `video_url` | [components.LegacyChatContentVideoInput](../components/legacychatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/components/legacychatcontentvideoinput.mdx b/docs/components/legacychatcontentvideoinput.mdx index 83f59a563..0ad9b1978 100644 --- a/docs/components/legacychatcontentvideoinput.mdx +++ b/docs/components/legacychatcontentvideoinput.mdx @@ -9,5 +9,5 @@ Video input object | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `processing` | [Optional[components.LegacyChatContentVideoInputProcessing]](../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` | *str* | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file +| `processing` | [Optional[components.LegacyChatContentVideoInputProcessing]](../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` | *str* | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/components/legacywebsearchservertool.mdx b/docs/components/legacywebsearchservertool.mdx index fc8f8785b..1fb233bb0 100644 --- a/docs/components/legacywebsearchservertool.mdx +++ b/docs/components/legacywebsearchservertool.mdx @@ -9,12 +9,12 @@ Web search tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `max_results` | *Optional[int]* | :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 | -| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [components.LegacyWebSearchServerToolType](../components/legacywebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../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"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `max_results` | *Optional[int]* | ➖ | 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 | +| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `type` | [components.LegacyWebSearchServerToolType](../components/legacywebsearchservertooltype.mdx) | ✅ | N/A | | +| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../components/websearchuserlocation.mdx) | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/listbyokkeysresponse.mdx b/docs/components/listbyokkeysresponse.mdx index 4e7fce4c2..a8e712fe1 100644 --- a/docs/components/listbyokkeysresponse.mdx +++ b/docs/components/listbyokkeysresponse.mdx @@ -6,5 +6,5 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | List[[components.BYOKKey](../components/byokkey.mdx)] | :heavy_check_mark: | List of BYOK credentials. | | -| `total_count` | *int* | :heavy_check_mark: | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file +| `data` | List[[components.BYOKKey](../components/byokkey.mdx)] | ✅ | List of BYOK credentials. | | +| `total_count` | *int* | ✅ | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file diff --git a/docs/components/listendpointsresponse.mdx b/docs/components/listendpointsresponse.mdx index 2df1189da..6bc0bc282 100644 --- a/docs/components/listendpointsresponse.mdx +++ b/docs/components/listendpointsresponse.mdx @@ -9,9 +9,9 @@ List of available endpoints for a model | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [components.Architecture](../components/architecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *str* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `endpoints` | List[[components.PublicEndpoint](../components/publicendpoint.mdx)] | :heavy_check_mark: | List of available endpoints for this model | | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | \ No newline at end of file +| `architecture` | [components.Architecture](../components/architecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `created` | *int* | ✅ | Unix timestamp of when the model was created | 1692901234 | +| `description` | *str* | ✅ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `endpoints` | List[[components.PublicEndpoint](../components/publicendpoint.mdx)] | ✅ | List of available endpoints for this model | | +| `id` | *str* | ✅ | Unique identifier for the model | openai/gpt-4 | +| `name` | *str* | ✅ | Display name of the model | GPT-4 | \ No newline at end of file diff --git a/docs/components/listendusersresponse.mdx b/docs/components/listendusersresponse.mdx index b95cdd819..0ba987a1d 100644 --- a/docs/components/listendusersresponse.mdx +++ b/docs/components/listendusersresponse.mdx @@ -6,5 +6,5 @@ title: "ListEndUsersResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `data` | List[[components.EndUser](../components/enduser.mdx)] | :heavy_check_mark: | N/A | | -| `total_count` | *int* | :heavy_check_mark: | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file +| `data` | List[[components.EndUser](../components/enduser.mdx)] | ✅ | N/A | | +| `total_count` | *int* | ✅ | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file diff --git a/docs/components/listguardrailsresponse.mdx b/docs/components/listguardrailsresponse.mdx index b62bb9a80..fd933202e 100644 --- a/docs/components/listguardrailsresponse.mdx +++ b/docs/components/listguardrailsresponse.mdx @@ -6,5 +6,5 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | List[[components.Guardrail](../components/guardrail.mdx)] | :heavy_check_mark: | List of guardrails | | -| `total_count` | *int* | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file +| `data` | List[[components.Guardrail](../components/guardrail.mdx)] | ✅ | List of guardrails | | +| `total_count` | *int* | ✅ | Total number of guardrails | 25 | \ No newline at end of file diff --git a/docs/components/listkeyassignmentsresponse.mdx b/docs/components/listkeyassignmentsresponse.mdx index c6806c4ab..f3f456c35 100644 --- a/docs/components/listkeyassignmentsresponse.mdx +++ b/docs/components/listkeyassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `data` | List[[components.KeyAssignment](../components/keyassignment.mdx)] | :heavy_check_mark: | List of key assignments | | -| `total_count` | *int* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file +| `data` | List[[components.KeyAssignment](../components/keyassignment.mdx)] | ✅ | List of key assignments | | +| `total_count` | *int* | ✅ | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/docs/components/listmemberassignmentsresponse.mdx b/docs/components/listmemberassignmentsresponse.mdx index 9e72b130e..498dddf60 100644 --- a/docs/components/listmemberassignmentsresponse.mdx +++ b/docs/components/listmemberassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | List[[components.MemberAssignment](../components/memberassignment.mdx)] | :heavy_check_mark: | List of member assignments | | -| `total_count` | *int* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file +| `data` | List[[components.MemberAssignment](../components/memberassignment.mdx)] | ✅ | List of member assignments | | +| `total_count` | *int* | ✅ | Total number of member assignments | 10 | \ No newline at end of file diff --git a/docs/components/listobservabilitydestinationsresponse.mdx b/docs/components/listobservabilitydestinationsresponse.mdx index 912c6caf6..8d41b819a 100644 --- a/docs/components/listobservabilitydestinationsresponse.mdx +++ b/docs/components/listobservabilitydestinationsresponse.mdx @@ -6,5 +6,5 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | List[[components.ObservabilityDestination](../components/observabilitydestination.mdx)] | :heavy_check_mark: | List of observability destinations. | | -| `total_count` | *int* | :heavy_check_mark: | Total number of destinations matching the filters. | 1 | \ No newline at end of file +| `data` | List[[components.ObservabilityDestination](../components/observabilitydestination.mdx)] | ✅ | List of observability destinations. | | +| `total_count` | *int* | ✅ | Total number of destinations matching the filters. | 1 | \ No newline at end of file diff --git a/docs/components/listpresetsresponse.mdx b/docs/components/listpresetsresponse.mdx index da04cab09..b2b084fe6 100644 --- a/docs/components/listpresetsresponse.mdx +++ b/docs/components/listpresetsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of presets. | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `data` | List[[components.Preset](../components/preset.mdx)] | :heavy_check_mark: | N/A | -| `total_count` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.Preset](../components/preset.mdx)] | ✅ | N/A | +| `total_count` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/listpresetversionsresponse.mdx b/docs/components/listpresetversionsresponse.mdx index 768df799d..83a88b92f 100644 --- a/docs/components/listpresetversionsresponse.mdx +++ b/docs/components/listpresetversionsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of preset versions. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `data` | List[[Nullable[components.PresetDesignatedVersion]](../components/presetdesignatedversion.mdx)] | :heavy_check_mark: | N/A | -| `total_count` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[Nullable[components.PresetDesignatedVersion]](../components/presetdesignatedversion.mdx)] | ✅ | N/A | +| `total_count` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/listprivateendpointsresponse.mdx b/docs/components/listprivateendpointsresponse.mdx index 5eae1fca7..149357e7f 100644 --- a/docs/components/listprivateendpointsresponse.mdx +++ b/docs/components/listprivateendpointsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPrivateEndpointsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `data` | List[[components.PrivateEndpointSummary](../components/privateendpointsummary.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.PrivateEndpointSummary](../components/privateendpointsummary.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/listscimgroupmappingsresponse.mdx b/docs/components/listscimgroupmappingsresponse.mdx index 14dff7d7d..a830bbd09 100644 --- a/docs/components/listscimgroupmappingsresponse.mdx +++ b/docs/components/listscimgroupmappingsresponse.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupMappingsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | List[[components.ScimGroupMapping](../components/scimgroupmapping.mdx)] | :heavy_check_mark: | N/A | -| `total_count` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.ScimGroupMapping](../components/scimgroupmapping.mdx)] | ✅ | N/A | +| `total_count` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/listscimgroupsresponse.mdx b/docs/components/listscimgroupsresponse.mdx index 6c0e6c816..69d85e646 100644 --- a/docs/components/listscimgroupsresponse.mdx +++ b/docs/components/listscimgroupsresponse.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupsResponse" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | List[[components.ScimGroup](../components/scimgroup.mdx)] | :heavy_check_mark: | N/A | -| `total_count` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.ScimGroup](../components/scimgroup.mdx)] | ✅ | N/A | +| `total_count` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/listtoolsresponse.mdx b/docs/components/listtoolsresponse.mdx index c62bef38e..0fcd54cb6 100644 --- a/docs/components/listtoolsresponse.mdx +++ b/docs/components/listtoolsresponse.mdx @@ -6,6 +6,6 @@ title: "ListToolsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `data` | List[[components.ServerTool](../components/servertool.mdx)] | :heavy_check_mark: | N/A | | -| `links` | [components.ListToolsResponseLinks](../components/listtoolsresponselinks.mdx) | :heavy_check_mark: | N/A | | -| `total_count` | *int* | :heavy_check_mark: | Total number of tools | 12 | \ No newline at end of file +| `data` | List[[components.ServerTool](../components/servertool.mdx)] | ✅ | N/A | | +| `links` | [components.ListToolsResponseLinks](../components/listtoolsresponselinks.mdx) | ✅ | N/A | | +| `total_count` | *int* | ✅ | Total number of tools | 12 | \ No newline at end of file diff --git a/docs/components/listtoolsresponselinks.mdx b/docs/components/listtoolsresponselinks.mdx index fe7710735..4ef36b167 100644 --- a/docs/components/listtoolsresponselinks.mdx +++ b/docs/components/listtoolsresponselinks.mdx @@ -6,4 +6,4 @@ title: "ListToolsResponseLinks" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `next` | *Nullable[str]* | :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` | *Nullable[str]* | ✅ | 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/components/listworkspacebudgetsresponse.mdx b/docs/components/listworkspacebudgetsresponse.mdx index 349ee6c92..940f25f6b 100644 --- a/docs/components/listworkspacebudgetsresponse.mdx +++ b/docs/components/listworkspacebudgetsresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspaceBudgetsResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.WorkspaceBudget](../components/workspacebudget.mdx)] | :heavy_check_mark: | List of budgets configured for the workspace | | -| `include_byok_in_budgets` | *Optional[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` | List[[components.WorkspaceBudget](../components/workspacebudget.mdx)] | ✅ | List of budgets configured for the workspace | | +| `include_byok_in_budgets` | *Optional[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/components/listworkspacemembersresponse.mdx b/docs/components/listworkspacemembersresponse.mdx index 90edcaf6b..c311fb895 100644 --- a/docs/components/listworkspacemembersresponse.mdx +++ b/docs/components/listworkspacemembersresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | List[[components.WorkspaceMember](../components/workspacemember.mdx)] | :heavy_check_mark: | List of workspace members | | -| `total_count` | *int* | :heavy_check_mark: | Total number of members in the workspace | 5 | \ No newline at end of file +| `data` | List[[components.WorkspaceMember](../components/workspacemember.mdx)] | ✅ | List of workspace members | | +| `total_count` | *int* | ✅ | Total number of members in the workspace | 5 | \ No newline at end of file diff --git a/docs/components/listworkspacesresponse.mdx b/docs/components/listworkspacesresponse.mdx index b78013a42..e84484702 100644 --- a/docs/components/listworkspacesresponse.mdx +++ b/docs/components/listworkspacesresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | List[[components.Workspace](../components/workspace.mdx)] | :heavy_check_mark: | List of workspaces | | -| `total_count` | *int* | :heavy_check_mark: | Total number of workspaces | 5 | \ No newline at end of file +| `data` | List[[components.Workspace](../components/workspace.mdx)] | ✅ | List of workspaces | | +| `total_count` | *int* | ✅ | Total number of workspaces | 5 | \ No newline at end of file diff --git a/docs/components/localshellcallitem.mdx b/docs/components/localshellcallitem.mdx index c3ce8fe82..93382ae4a 100644 --- a/docs/components/localshellcallitem.mdx +++ b/docs/components/localshellcallitem.mdx @@ -9,8 +9,8 @@ A local shell command execution call | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `action` | [components.LocalShellCallItemAction](../components/localshellcallitemaction.mdx) | :heavy_check_mark: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.TypeLocalShellCall](../components/typelocalshellcall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [components.LocalShellCallItemAction](../components/localshellcallitemaction.mdx) | ✅ | N/A | | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.TypeLocalShellCall](../components/typelocalshellcall.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/localshellcallitemaction.mdx b/docs/components/localshellcallitemaction.mdx index 584d53921..4f386bb68 100644 --- a/docs/components/localshellcallitemaction.mdx +++ b/docs/components/localshellcallitemaction.mdx @@ -6,9 +6,9 @@ title: "LocalShellCallItemAction" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `command` | List[*str*] | :heavy_check_mark: | N/A | -| `env` | Dict[str, *str*] | :heavy_check_mark: | N/A | -| `timeout_ms` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `type` | [components.TypeExec](../components/typeexec.mdx) | :heavy_check_mark: | N/A | -| `user` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `working_directory` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `command` | List[*str*] | ✅ | N/A | +| `env` | Dict[str, *str*] | ✅ | N/A | +| `timeout_ms` | *OptionalNullable[int]* | ➖ | N/A | +| `type` | [components.TypeExec](../components/typeexec.mdx) | ✅ | N/A | +| `user` | *OptionalNullable[str]* | ➖ | N/A | +| `working_directory` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/localshellcalloutputitem.mdx b/docs/components/localshellcalloutputitem.mdx index eff6d3493..a6ed03152 100644 --- a/docs/components/localshellcalloutputitem.mdx +++ b/docs/components/localshellcalloutputitem.mdx @@ -9,7 +9,7 @@ Output from a local shell command execution | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `output` | *str* | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.LocalShellCallOutputItemType](../components/localshellcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *str* | ✅ | N/A | | +| `output` | *str* | ✅ | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [components.LocalShellCallOutputItemType](../components/localshellcalloutputitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/logprob.mdx b/docs/components/logprob.mdx index 6345da5c5..18d71fff1 100644 --- a/docs/components/logprob.mdx +++ b/docs/components/logprob.mdx @@ -6,7 +6,7 @@ title: "Logprob" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `top_logprobs` | List[[components.ResponseOutputTextTopLogprob](../components/responseoutputtexttoplogprob.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | ✅ | N/A | +| `logprob` | *float* | ✅ | N/A | +| `token` | *str* | ✅ | N/A | +| `top_logprobs` | List[[components.ResponseOutputTextTopLogprob](../components/responseoutputtexttoplogprob.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/logprobs.mdx b/docs/components/logprobs.mdx index c0b2da9f7..2b9725648 100644 --- a/docs/components/logprobs.mdx +++ b/docs/components/logprobs.mdx @@ -6,5 +6,5 @@ title: "Logprobs" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `content` | List[[components.LogprobsContent](../components/logprobscontent.mdx)] | :heavy_check_mark: | N/A | -| `refusal` | List[[components.Refusal](../components/refusal.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | List[[components.LogprobsContent](../components/logprobscontent.mdx)] | ✅ | N/A | +| `refusal` | List[[components.Refusal](../components/refusal.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/logprobscontent.mdx b/docs/components/logprobscontent.mdx index 0645e0cdd..bce4cf6f8 100644 --- a/docs/components/logprobscontent.mdx +++ b/docs/components/logprobscontent.mdx @@ -6,7 +6,7 @@ title: "LogprobsContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `top_logprobs` | List[[components.ContentTopLogprob](../components/contenttoplogprob.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | ✅ | N/A | +| `logprob` | *float* | ✅ | N/A | +| `token` | *str* | ✅ | N/A | +| `top_logprobs` | List[[components.ContentTopLogprob](../components/contenttoplogprob.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/managedprivateendpoint.mdx b/docs/components/managedprivateendpoint.mdx index 31440c7b7..384f5ea97 100644 --- a/docs/components/managedprivateendpoint.mdx +++ b/docs/components/managedprivateendpoint.mdx @@ -6,12 +6,12 @@ title: "ManagedPrivateEndpoint" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `model_name` | *Nullable[str]* | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `model_slug` | *Nullable[str]* | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `provider_name` | *str* | :heavy_check_mark: | Display name of the upstream provider. | Azure | -| `status` | [components.PrivateEndpointStatus](../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 | -| `declared_region` | [Nullable[components.PrivateEndpointDeclaredRegion]](../components/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `declared_zdr` | *Nullable[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 +| `created_at` | *str* | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `model_name` | *Nullable[str]* | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `model_slug` | *Nullable[str]* | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `provider_name` | *str* | ✅ | Display name of the upstream provider. | Azure | +| `status` | [components.PrivateEndpointStatus](../components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | +| `declared_region` | [Nullable[components.PrivateEndpointDeclaredRegion]](../components/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `declared_zdr` | *Nullable[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/components/managedprivateendpointresponse.mdx b/docs/components/managedprivateendpointresponse.mdx index f14bc4a6c..585a2cdc3 100644 --- a/docs/components/managedprivateendpointresponse.mdx +++ b/docs/components/managedprivateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "ManagedPrivateEndpointResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `data` | [components.ManagedPrivateEndpoint](../components/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.ManagedPrivateEndpoint](../components/managedprivateendpoint.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/match.mdx b/docs/components/match.mdx index c6bb3ad84..05119d7c4 100644 --- a/docs/components/match.mdx +++ b/docs/components/match.mdx @@ -6,6 +6,6 @@ title: "Match" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `definition` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `schema_digest` | *str* | :heavy_check_mark: | N/A | -| `tool_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `definition` | Dict[str, *Any*] | ✅ | N/A | +| `schema_digest` | *str* | ✅ | N/A | +| `tool_id` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/maxprice.mdx b/docs/components/maxprice.mdx index e1892e259..2e70934f4 100644 --- a/docs/components/maxprice.mdx +++ b/docs/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` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per audio unit | -| `completion` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per million completion tokens | -| `image` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per image | -| `prompt` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per million prompt tokens | -| `request` | *Optional[str]* | :heavy_minus_sign: | Maximum price in USD per request | \ No newline at end of file +| `audio` | *Optional[str]* | ➖ | Maximum price in USD per audio unit | +| `completion` | *Optional[str]* | ➖ | Maximum price in USD per million completion tokens | +| `image` | *Optional[str]* | ➖ | Maximum price in USD per image | +| `prompt` | *Optional[str]* | ➖ | Maximum price in USD per million prompt tokens | +| `request` | *Optional[str]* | ➖ | Maximum price in USD per request | \ No newline at end of file diff --git a/docs/components/mcpapprovalrequestitem.mdx b/docs/components/mcpapprovalrequestitem.mdx index d02d66656..3fd987097 100644 --- a/docs/components/mcpapprovalrequestitem.mdx +++ b/docs/components/mcpapprovalrequestitem.mdx @@ -9,8 +9,8 @@ Request for approval to execute an MCP tool | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `server_label` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.McpApprovalRequestItemType](../components/mcpapprovalrequestitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `name` | *str* | ✅ | N/A | +| `server_label` | *str* | ✅ | N/A | +| `type` | [components.McpApprovalRequestItemType](../components/mcpapprovalrequestitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/mcpapprovalresponseitem.mdx b/docs/components/mcpapprovalresponseitem.mdx index d67c1e405..dda41b5c7 100644 --- a/docs/components/mcpapprovalresponseitem.mdx +++ b/docs/components/mcpapprovalresponseitem.mdx @@ -9,8 +9,8 @@ User response to an MCP tool approval request | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `approval_request_id` | *str* | :heavy_check_mark: | N/A | -| `approve` | *bool* | :heavy_check_mark: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `reason` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.McpApprovalResponseItemType](../components/mcpapprovalresponseitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `approval_request_id` | *str* | ✅ | N/A | +| `approve` | *bool* | ✅ | N/A | +| `id` | *OptionalNullable[str]* | ➖ | N/A | +| `reason` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.McpApprovalResponseItemType](../components/mcpapprovalresponseitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/mcpcallitem.mdx b/docs/components/mcpcallitem.mdx index 3c63a3b9e..c79ed0adf 100644 --- a/docs/components/mcpcallitem.mdx +++ b/docs/components/mcpcallitem.mdx @@ -9,10 +9,10 @@ An MCP tool call with its output or error | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | N/A | | -| `error` | [OptionalNullable[components.McpToolCallError]](../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` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `output` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `server_label` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.McpCallItemType](../components/mcpcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | | +| `error` | [OptionalNullable[components.McpToolCallError]](../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` | *str* | ✅ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `output` | *OptionalNullable[str]* | ➖ | N/A | | +| `server_label` | *str* | ✅ | N/A | | +| `type` | [components.McpCallItemType](../components/mcpcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/mcphttperror.mdx b/docs/components/mcphttperror.mdx index 5f845e652..5fe8945e6 100644 --- a/docs/components/mcphttperror.mdx +++ b/docs/components/mcphttperror.mdx @@ -9,6 +9,6 @@ The MCP server request failed at the HTTP layer | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.McpHTTPErrorType](../components/mcphttperrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `type` | [components.McpHTTPErrorType](../components/mcphttperrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/mcplisttoolsitem.mdx b/docs/components/mcplisttoolsitem.mdx index decba2cc8..f2865a837 100644 --- a/docs/components/mcplisttoolsitem.mdx +++ b/docs/components/mcplisttoolsitem.mdx @@ -9,8 +9,8 @@ List of available MCP tools from a server | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `error` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `server_label` | *str* | :heavy_check_mark: | N/A | -| `tools` | List[[components.McpListToolsItemTool](../components/mcplisttoolsitemtool.mdx)] | :heavy_check_mark: | N/A | -| `type` | [components.McpListToolsItemType](../components/mcplisttoolsitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | *OptionalNullable[str]* | ➖ | N/A | +| `id` | *str* | ✅ | N/A | +| `server_label` | *str* | ✅ | N/A | +| `tools` | List[[components.McpListToolsItemTool](../components/mcplisttoolsitemtool.mdx)] | ✅ | N/A | +| `type` | [components.McpListToolsItemType](../components/mcplisttoolsitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/mcplisttoolsitemtool.mdx b/docs/components/mcplisttoolsitemtool.mdx index b36fb7dc0..8997f1c7a 100644 --- a/docs/components/mcplisttoolsitemtool.mdx +++ b/docs/components/mcplisttoolsitemtool.mdx @@ -6,7 +6,7 @@ title: "McpListToolsItemTool" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `annotations` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `input_schema` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `annotations` | *Optional[Any]* | ➖ | N/A | +| `description` | *OptionalNullable[str]* | ➖ | N/A | +| `input_schema` | Dict[str, *Any*] | ✅ | N/A | +| `name` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/mcpprotocolerror.mdx b/docs/components/mcpprotocolerror.mdx index 9f3acaccd..73c54663a 100644 --- a/docs/components/mcpprotocolerror.mdx +++ b/docs/components/mcpprotocolerror.mdx @@ -9,6 +9,6 @@ The MCP server returned a protocol-level error | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.McpProtocolErrorType](../components/mcpprotocolerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `type` | [components.McpProtocolErrorType](../components/mcpprotocolerrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/mcpservertool.mdx b/docs/components/mcpservertool.mdx index 70f051981..be92ba849 100644 --- a/docs/components/mcpservertool.mdx +++ b/docs/components/mcpservertool.mdx @@ -9,12 +9,12 @@ MCP (Model Context Protocol) tool configuration | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `allowed_tools` | [OptionalNullable[components.AllowedToolsUnion]](../components/allowedtoolsunion.mdx) | :heavy_minus_sign: | N/A | -| `authorization` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `connector_id` | [Optional[components.ConnectorID]](../components/connectorid.mdx) | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | N/A | -| `require_approval` | [OptionalNullable[components.RequireApprovalUnion]](../components/requireapprovalunion.mdx) | :heavy_minus_sign: | N/A | -| `server_description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `server_label` | *str* | :heavy_check_mark: | N/A | -| `server_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.McpServerToolType](../components/mcpservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `allowed_tools` | [OptionalNullable[components.AllowedToolsUnion]](../components/allowedtoolsunion.mdx) | ➖ | N/A | +| `authorization` | *Optional[str]* | ➖ | N/A | +| `connector_id` | [Optional[components.ConnectorID]](../components/connectorid.mdx) | ➖ | N/A | +| `headers` | Dict[str, *str*] | ➖ | N/A | +| `require_approval` | [OptionalNullable[components.RequireApprovalUnion]](../components/requireapprovalunion.mdx) | ➖ | N/A | +| `server_description` | *Optional[str]* | ➖ | N/A | +| `server_label` | *str* | ✅ | N/A | +| `server_url` | *Optional[str]* | ➖ | N/A | +| `type` | [components.McpServerToolType](../components/mcpservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/mcptoolexecutionerror.mdx b/docs/components/mcptoolexecutionerror.mdx index 6a11b52b9..195ca1bdc 100644 --- a/docs/components/mcptoolexecutionerror.mdx +++ b/docs/components/mcptoolexecutionerror.mdx @@ -9,5 +9,5 @@ The MCP tool ran but reported a failure | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `content` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `type` | [components.McpToolExecutionErrorType](../components/mcptoolexecutionerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *Optional[Any]* | ➖ | N/A | +| `type` | [components.McpToolExecutionErrorType](../components/mcptoolexecutionerrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/memberassignment.mdx b/docs/components/memberassignment.mdx index 589bcb61c..5ca7f4d1b 100644 --- a/docs/components/memberassignment.mdx +++ b/docs/components/memberassignment.mdx @@ -6,9 +6,9 @@ title: "MemberAssignment" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `organization_id` | *str* | :heavy_check_mark: | Organization ID | org_xyz789 | -| `user_id` | *str* | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file +| `assigned_by` | *Nullable[str]* | ✅ | User ID of who made the assignment | user_abc123 | +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `guardrail_id` | *str* | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `id` | *str* | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `organization_id` | *str* | ✅ | Organization ID | org_xyz789 | +| `user_id` | *str* | ✅ | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file diff --git a/docs/components/message.mdx b/docs/components/message.mdx index 293ccd909..d582933aa 100644 --- a/docs/components/message.mdx +++ b/docs/components/message.mdx @@ -6,11 +6,11 @@ title: "Message" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `annotations` | List[[components.Annotation](../components/annotation.mdx)] | :heavy_minus_sign: | N/A | -| `content` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `images` | List[[components.Image](../components/image.mdx)] | :heavy_minus_sign: | N/A | -| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `reasoning_details` | List[[Nullable[components.ReasoningDetail]](../components/reasoningdetail.mdx)] | :heavy_minus_sign: | N/A | -| `refusal` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `role` | [components.ChoiceRole](../components/choicerole.mdx) | :heavy_check_mark: | N/A | -| `tool_calls` | List[[components.ToolCall](../components/toolcall.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `annotations` | List[[components.Annotation](../components/annotation.mdx)] | ➖ | N/A | +| `content` | *Nullable[str]* | ✅ | N/A | +| `images` | List[[components.Image](../components/image.mdx)] | ➖ | N/A | +| `reasoning` | *OptionalNullable[str]* | ➖ | N/A | +| `reasoning_details` | List[[Nullable[components.ReasoningDetail]](../components/reasoningdetail.mdx)] | ➖ | N/A | +| `refusal` | *Nullable[str]* | ✅ | N/A | +| `role` | [components.ChoiceRole](../components/choicerole.mdx) | ✅ | N/A | +| `tool_calls` | List[[components.ToolCall](../components/toolcall.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/messagesadvisortoolresultblock.mdx b/docs/components/messagesadvisortoolresultblock.mdx index 8ae2160d7..67193439a 100644 --- a/docs/components/messagesadvisortoolresultblock.mdx +++ b/docs/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` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesAdvisorToolResultBlockType](../components/messagesadvisortoolresultblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | Dict[str, *Any*] | ✅ | N/A | +| `tool_use_id` | *str* | ✅ | N/A | +| `type` | [components.MessagesAdvisorToolResultBlockType](../components/messagesadvisortoolresultblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagesbashtoolresultblock.mdx b/docs/components/messagesbashtoolresultblock.mdx index cf49493d9..70c76d061 100644 --- a/docs/components/messagesbashtoolresultblock.mdx +++ b/docs/components/messagesbashtoolresultblock.mdx @@ -9,8 +9,8 @@ Output of a sandbox-executed `openrouter:bash` call from a prior assistant turn. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *Optional[str]* | :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` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `files` | List[[components.MessagesBashToolResultBlockFile](../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. | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesBashToolResultBlockTypeOpenrouterBashToolResult](../components/messagesbashtoolresultblocktypeopenrouterbashtoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *Optional[str]* | ➖ | 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` | Dict[str, *Any*] | ✅ | N/A | +| `files` | List[[components.MessagesBashToolResultBlockFile](../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. | +| `tool_use_id` | *str* | ✅ | N/A | +| `type` | [components.MessagesBashToolResultBlockTypeOpenrouterBashToolResult](../components/messagesbashtoolresultblocktypeopenrouterbashtoolresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagesbashtoolresultblockfile.mdx b/docs/components/messagesbashtoolresultblockfile.mdx index 74a698936..1e8069a1c 100644 --- a/docs/components/messagesbashtoolresultblockfile.mdx +++ b/docs/components/messagesbashtoolresultblockfile.mdx @@ -6,9 +6,9 @@ title: "MessagesBashToolResultBlockFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | :heavy_check_mark: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesBashToolResultBlockTypeContainerFileCitation](../components/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *str* | ✅ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `file_id` | *str* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `type` | [components.MessagesBashToolResultBlockTypeContainerFileCitation](../components/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagesfallbackparam.mdx b/docs/components/messagesfallbackparam.mdx index a6a32a1a5..012492726 100644 --- a/docs/components/messagesfallbackparam.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file +| `model` | *str* | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file diff --git a/docs/components/messagesmessageparam.mdx b/docs/components/messagesmessageparam.mdx index 26c3fa025..e32cd7515 100644 --- a/docs/components/messagesmessageparam.mdx +++ b/docs/components/messagesmessageparam.mdx @@ -9,7 +9,7 @@ Anthropic message with OpenRouter extensions | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `clear_at` | [OptionalNullable[components.AnthropicSystemClearAt]](../components/anthropicsystemclearat.mdx) | :heavy_minus_sign: | N/A | next_user_message | -| `content` | [components.MessagesMessageParamContentUnion5](../components/messagesmessageparamcontentunion5.mdx) | :heavy_check_mark: | N/A | | -| `output_config` | [OptionalNullable[components.AnthropicMessageOutputConfig]](../components/anthropicmessageoutputconfig.mdx) | :heavy_minus_sign: | N/A | \{
"effort": "low"
} | -| `role` | [components.MessagesMessageParamRole](../components/messagesmessageparamrole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `clear_at` | [OptionalNullable[components.AnthropicSystemClearAt]](../components/anthropicsystemclearat.mdx) | ➖ | N/A | next_user_message | +| `content` | [components.MessagesMessageParamContentUnion5](../components/messagesmessageparamcontentunion5.mdx) | ✅ | N/A | | +| `output_config` | [OptionalNullable[components.AnthropicMessageOutputConfig]](../components/anthropicmessageoutputconfig.mdx) | ➖ | N/A | \{
"effort": "low"
} | +| `role` | [components.MessagesMessageParamRole](../components/messagesmessageparamrole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/messagesoutputconfig.mdx b/docs/components/messagesoutputconfig.mdx index b5ce8e911..62aac47ba 100644 --- a/docs/components/messagesoutputconfig.mdx +++ b/docs/components/messagesoutputconfig.mdx @@ -9,6 +9,6 @@ Configuration for controlling output behavior. Supports the effort parameter and | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.MessagesOutputConfigEffort]](../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[components.MessagesOutputConfigFormat]](../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). | | -| `task_budget` | [OptionalNullable[components.TaskBudget]](../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[components.MessagesOutputConfigEffort]](../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[components.MessagesOutputConfigFormat]](../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). | | +| `task_budget` | [OptionalNullable[components.TaskBudget]](../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/components/messagesoutputconfigformat.mdx b/docs/components/messagesoutputconfigformat.mdx index cf56b3030..4176103d2 100644 --- a/docs/components/messagesoutputconfigformat.mdx +++ b/docs/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_` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `type` | [components.MessagesOutputConfigTypeJSONSchema](../components/messagesoutputconfigtypejsonschema.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `schema_` | Dict[str, *Any*] | ✅ | N/A | +| `type` | [components.MessagesOutputConfigTypeJSONSchema](../components/messagesoutputconfigtypejsonschema.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagesrequest.mdx b/docs/components/messagesrequest.mdx index 112001bf6..1049209ba 100644 --- a/docs/components/messagesrequest.mdx +++ b/docs/components/messagesrequest.mdx @@ -9,31 +9,31 @@ Request schema for Anthropic Messages API endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `context_management` | [OptionalNullable[components.ContextManagement]](../components/contextmanagement.mdx) | :heavy_minus_sign: | N/A | | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `fallbacks` | List[[components.MessagesFallbackParam](../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"
}
] | -| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `messages` | List[[components.MessagesMessageParam](../components/messagesmessageparam.mdx)] | :heavy_check_mark: | N/A | | -| `metadata` | [Optional[components.MessagesRequestMetadata]](../components/messagesrequestmetadata.mdx) | :heavy_minus_sign: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `output_config` | [Optional[components.MessagesOutputConfig]](../components/messagesoutputconfig.mdx) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | -| `plugins` | List[[components.MessagesRequestPlugin](../components/messagesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `safeguards` | List[[components.AnthropicSafeguard](../components/anthropicsafeguard.mdx)] | :heavy_minus_sign: | N/A | | -| `service_tier` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `session_id` | *Optional[str]* | :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[components.Speed]](../components/speed.mdx) | :heavy_minus_sign: | N/A | fast | -| `stop_sequences` | List[*str*] | :heavy_minus_sign: | N/A | | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `system` | [Optional[components.System]](../components/system.mdx) | :heavy_minus_sign: | N/A | | -| `temperature` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `thinking` | [Optional[components.Thinking]](../components/thinking.mdx) | :heavy_minus_sign: | N/A | | -| `tool_choice` | [Optional[components.ToolChoice]](../components/toolchoice.mdx) | :heavy_minus_sign: | N/A | | -| `tools` | List[[components.MessagesRequestToolUnion](../components/messagesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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 +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `context_management` | [OptionalNullable[components.ContextManagement]](../components/contextmanagement.mdx) | ➖ | N/A | | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `fallbacks` | List[[components.MessagesFallbackParam](../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"
}
] | +| `max_tokens` | *Optional[int]* | ➖ | N/A | | +| `messages` | List[[components.MessagesMessageParam](../components/messagesmessageparam.mdx)] | ✅ | N/A | | +| `metadata` | [Optional[components.MessagesRequestMetadata]](../components/messagesrequestmetadata.mdx) | ➖ | N/A | | +| `model` | *str* | ✅ | N/A | | +| `models` | List[*str*] | ➖ | N/A | | +| `output_config` | [Optional[components.MessagesOutputConfig]](../components/messagesoutputconfig.mdx) | ➖ | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | +| `plugins` | List[[components.MessagesRequestPlugin](../components/messagesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `safeguards` | List[[components.AnthropicSafeguard](../components/anthropicsafeguard.mdx)] | ➖ | N/A | | +| `service_tier` | *Optional[str]* | ➖ | N/A | | +| `session_id` | *Optional[str]* | ➖ | 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[components.Speed]](../components/speed.mdx) | ➖ | N/A | fast | +| `stop_sequences` | List[*str*] | ➖ | N/A | | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[bool]* | ➖ | N/A | | +| `system` | [Optional[components.System]](../components/system.mdx) | ➖ | N/A | | +| `temperature` | *Optional[float]* | ➖ | N/A | | +| `thinking` | [Optional[components.Thinking]](../components/thinking.mdx) | ➖ | N/A | | +| `tool_choice` | [Optional[components.ToolChoice]](../components/toolchoice.mdx) | ➖ | N/A | | +| `tools` | List[[components.MessagesRequestToolUnion](../components/messagesrequesttoolunion.mdx)] | ➖ | N/A | | +| `top_k` | *Optional[int]* | ➖ | N/A | | +| `top_p` | *Optional[float]* | ➖ | N/A | | +| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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/components/messagesrequestmetadata.mdx b/docs/components/messagesrequestmetadata.mdx index fb2a55630..fd4842ebf 100644 --- a/docs/components/messagesrequestmetadata.mdx +++ b/docs/components/messagesrequestmetadata.mdx @@ -6,4 +6,4 @@ title: "MessagesRequestMetadata" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/messagesrequesttool.mdx b/docs/components/messagesrequesttool.mdx index d432bb08e..c16c1c899 100644 --- a/docs/components/messagesrequesttool.mdx +++ b/docs/components/messagesrequesttool.mdx @@ -6,5 +6,5 @@ title: "MessagesRequestTool" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *str* | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/messagessearchmodelsservertool.mdx b/docs/components/messagessearchmodelsservertool.mdx index e13f74e2a..74d09c305 100644 --- a/docs/components/messagessearchmodelsservertool.mdx +++ b/docs/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` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [components.MessagesSearchModelsServerToolType](../components/messagessearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [components.MessagesSearchModelsServerToolType](../components/messagessearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/messagesshelltoolresultblock.mdx b/docs/components/messagesshelltoolresultblock.mdx index c078c4b3b..f64863bbd 100644 --- a/docs/components/messagesshelltoolresultblock.mdx +++ b/docs/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 | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *Optional[str]* | :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` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `files` | List[[components.MessagesShellToolResultBlockFile](../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. | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesShellToolResultBlockTypeOpenrouterShellToolResult](../components/messagesshelltoolresultblocktypeopenroutershelltoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *Optional[str]* | ➖ | 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` | Dict[str, *Any*] | ✅ | N/A | +| `files` | List[[components.MessagesShellToolResultBlockFile](../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. | +| `tool_use_id` | *str* | ✅ | N/A | +| `type` | [components.MessagesShellToolResultBlockTypeOpenrouterShellToolResult](../components/messagesshelltoolresultblocktypeopenroutershelltoolresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagesshelltoolresultblockfile.mdx b/docs/components/messagesshelltoolresultblockfile.mdx index e659a859d..7107ecf01 100644 --- a/docs/components/messagesshelltoolresultblockfile.mdx +++ b/docs/components/messagesshelltoolresultblockfile.mdx @@ -6,9 +6,9 @@ title: "MessagesShellToolResultBlockFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | :heavy_check_mark: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesShellToolResultBlockTypeContainerFileCitation](../components/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *str* | ✅ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `file_id` | *str* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `type` | [components.MessagesShellToolResultBlockTypeContainerFileCitation](../components/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagestooladditionblock.mdx b/docs/components/messagestooladditionblock.mdx index 5a532b3a3..b9cf44fcb 100644 --- a/docs/components/messagestooladditionblock.mdx +++ b/docs/components/messagestooladditionblock.mdx @@ -9,6 +9,6 @@ Loads a previously deferred tool (declared in `tools` with `defer_loading: true` | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagestooladditionblocktoolunion.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeToolAddition](../components/typetooladdition.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagestooladditionblocktoolunion.mdx) | ✅ | N/A | | +| `type` | [components.TypeToolAddition](../components/typetooladdition.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/messagestooladditionblocktoolmcptoolreference.mdx b/docs/components/messagestooladditionblocktoolmcptoolreference.mdx index 8f35a41fc..02c7a9aaa 100644 --- a/docs/components/messagestooladditionblocktoolmcptoolreference.mdx +++ b/docs/components/messagestooladditionblocktoolmcptoolreference.mdx @@ -6,6 +6,6 @@ title: "MessagesToolAdditionBlockToolMcpToolReference" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | N/A | -| `server_name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../components/messagestooladditionblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *str* | ✅ | N/A | +| `server_name` | *str* | ✅ | N/A | +| `type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../components/messagestooladditionblocktypemcptoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagestooladditionblocktoolmcptoolsetreference.mdx b/docs/components/messagestooladditionblocktoolmcptoolsetreference.mdx index 807e31935..4d630c506 100644 --- a/docs/components/messagestooladditionblocktoolmcptoolsetreference.mdx +++ b/docs/components/messagestooladditionblocktoolmcptoolsetreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolAdditionBlockToolMcpToolsetReference" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `server_name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../components/messagestooladditionblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `server_name` | *str* | ✅ | N/A | +| `type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../components/messagestooladditionblocktypemcptoolsetreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagestooladditionblocktooltoolreference.mdx b/docs/components/messagestooladditionblocktooltoolreference.mdx index f56ec1fdc..acc92ca61 100644 --- a/docs/components/messagestooladditionblocktooltoolreference.mdx +++ b/docs/components/messagestooladditionblocktooltoolreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolAdditionBlockToolToolReference" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesToolAdditionBlockTypeToolReference](../components/messagestooladditionblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *str* | ✅ | N/A | +| `type` | [components.MessagesToolAdditionBlockTypeToolReference](../components/messagestooladditionblocktypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagestoolremovalblock.mdx b/docs/components/messagestoolremovalblock.mdx index a8f4a77b4..9d9efbc04 100644 --- a/docs/components/messagestoolremovalblock.mdx +++ b/docs/components/messagestoolremovalblock.mdx @@ -9,6 +9,6 @@ Removes a tool from the conversation mid-conversation without invalidating the p | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagestoolremovalblocktoolunion.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeToolRemoval](../components/typetoolremoval.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/messagestoolremovalblocktoolunion.mdx) | ✅ | N/A | | +| `type` | [components.TypeToolRemoval](../components/typetoolremoval.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/messagestoolremovalblocktoolmcptoolreference.mdx b/docs/components/messagestoolremovalblocktoolmcptoolreference.mdx index 63a22858d..1a20715e6 100644 --- a/docs/components/messagestoolremovalblocktoolmcptoolreference.mdx +++ b/docs/components/messagestoolremovalblocktoolmcptoolreference.mdx @@ -6,6 +6,6 @@ title: "MessagesToolRemovalBlockToolMcpToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `name` | *str* | :heavy_check_mark: | N/A | -| `server_name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../components/messagestoolremovalblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *str* | ✅ | N/A | +| `server_name` | *str* | ✅ | N/A | +| `type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../components/messagestoolremovalblocktypemcptoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagestoolremovalblocktoolmcptoolsetreference.mdx b/docs/components/messagestoolremovalblocktoolmcptoolsetreference.mdx index 39ce3ffdf..ffa9ce1a9 100644 --- a/docs/components/messagestoolremovalblocktoolmcptoolsetreference.mdx +++ b/docs/components/messagestoolremovalblocktoolmcptoolsetreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolRemovalBlockToolMcpToolsetReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `server_name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../components/messagestoolremovalblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `server_name` | *str* | ✅ | N/A | +| `type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../components/messagestoolremovalblocktypemcptoolsetreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/messagestoolremovalblocktooltoolreference.mdx b/docs/components/messagestoolremovalblocktooltoolreference.mdx index 5700e11ae..e6700109f 100644 --- a/docs/components/messagestoolremovalblocktooltoolreference.mdx +++ b/docs/components/messagestoolremovalblocktooltoolreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolRemovalBlockToolToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesToolRemovalBlockTypeToolReference](../components/messagestoolremovalblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *str* | ✅ | N/A | +| `type` | [components.MessagesToolRemovalBlockTypeToolReference](../components/messagestoolremovalblocktypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/mismatchbehavior.mdx b/docs/components/mismatchbehavior.mdx index 4082d3af8..b4a81493c 100644 --- a/docs/components/mismatchbehavior.mdx +++ b/docs/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/components/model.mdx b/docs/components/model.mdx index 43e26adf5..7901feacb 100644 --- a/docs/components/model.mdx +++ b/docs/components/model.mdx @@ -9,23 +9,23 @@ Information about an AI model available on OpenRouter | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alias_target` | [Optional[components.ModelAliasTarget]](../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](../components/modelarchitecture.mdx) | :heavy_check_mark: | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `benchmarks` | [Optional[components.ModelBenchmarks]](../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
}
]
} | -| `canonical_slug` | *str* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `context_length` | *Nullable[int]* | :heavy_check_mark: | Maximum context length in tokens | 8192 | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `default_parameters` | [Nullable[components.DefaultParameters]](../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` | *Optional[str]* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `expiration_date` | *OptionalNullable[str]* | :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 | -| `hugging_face_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `knowledge_cutoff` | *OptionalNullable[str]* | :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](../components/modellinks.mdx) | :heavy_check_mark: | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | -| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.mdx) | :heavy_check_mark: | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | -| `pricing` | [components.PublicPricing](../components/publicpricing.mdx) | :heavy_check_mark: | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | -| `reasoning` | [Optional[components.ModelReasoning]](../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"
]
} | -| `supported_parameters` | List[[components.Parameter](../components/parameter.mdx)] | :heavy_check_mark: | List of supported parameters for this model | | -| `supported_voices` | List[*str*] | :heavy_check_mark: | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | -| `top_provider` | [components.TopProviderInfo](../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 +| `alias_target` | [Optional[components.ModelAliasTarget]](../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](../components/modelarchitecture.mdx) | ✅ | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `benchmarks` | [Optional[components.ModelBenchmarks]](../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
}
]
} | +| `canonical_slug` | *str* | ✅ | Canonical slug for the model | openai/gpt-4 | +| `context_length` | *Nullable[int]* | ✅ | Maximum context length in tokens | 8192 | +| `created` | *int* | ✅ | Unix timestamp of when the model was created | 1692901234 | +| `default_parameters` | [Nullable[components.DefaultParameters]](../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` | *Optional[str]* | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `expiration_date` | *OptionalNullable[str]* | ➖ | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | +| `hugging_face_id` | *OptionalNullable[str]* | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `id` | *str* | ✅ | Unique identifier for the model | openai/gpt-4 | +| `knowledge_cutoff` | *OptionalNullable[str]* | ➖ | 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](../components/modellinks.mdx) | ✅ | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | +| `name` | *str* | ✅ | Display name of the model | GPT-4 | +| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.mdx) | ✅ | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | +| `pricing` | [components.PublicPricing](../components/publicpricing.mdx) | ✅ | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | +| `reasoning` | [Optional[components.ModelReasoning]](../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"
]
} | +| `supported_parameters` | List[[components.Parameter](../components/parameter.mdx)] | ✅ | List of supported parameters for this model | | +| `supported_voices` | List[*str*] | ✅ | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | +| `top_provider` | [components.TopProviderInfo](../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/components/modelaliastarget.mdx b/docs/components/modelaliastarget.mdx index 66d683bd2..176083da8 100644 --- a/docs/components/modelaliastarget.mdx +++ b/docs/components/modelaliastarget.mdx @@ -9,5 +9,5 @@ Concrete model targeted by this tilde-latest alias, when applicable | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Human-readable name of the concrete model targeted by this alias | -| `slug` | *str* | :heavy_check_mark: | Routable model ID of the concrete target, matching that model row's id | \ No newline at end of file +| `name` | *str* | ✅ | Human-readable name of the concrete model targeted by this alias | +| `slug` | *str* | ✅ | Routable model ID of the concrete target, matching that model row's id | \ No newline at end of file diff --git a/docs/components/modelarchitecture.mdx b/docs/components/modelarchitecture.mdx index d46fef469..acbd961bf 100644 --- a/docs/components/modelarchitecture.mdx +++ b/docs/components/modelarchitecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `input_modalities` | List[[components.InputModality](../components/inputmodality.mdx)] | :heavy_check_mark: | Supported input modalities | | -| `instruct_type` | [OptionalNullable[components.InstructType]](../components/instructtype.mdx) | :heavy_minus_sign: | Instruction format type | chatml | -| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text->text | -| `output_modalities` | List[[components.OutputModality](../components/outputmodality.mdx)] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [Optional[components.ModelGroup]](../components/modelgroup.mdx) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file +| `input_modalities` | List[[components.InputModality](../components/inputmodality.mdx)] | ✅ | Supported input modalities | | +| `instruct_type` | [OptionalNullable[components.InstructType]](../components/instructtype.mdx) | ➖ | Instruction format type | chatml | +| `modality` | *Nullable[str]* | ✅ | Primary modality of the model | text->text | +| `output_modalities` | List[[components.OutputModality](../components/outputmodality.mdx)] | ✅ | Supported output modalities | | +| `tokenizer` | [Optional[components.ModelGroup]](../components/modelgroup.mdx) | ➖ | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/docs/components/modelbenchmarks.mdx b/docs/components/modelbenchmarks.mdx index f9d4890de..526fec0fb 100644 --- a/docs/components/modelbenchmarks.mdx +++ b/docs/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 | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `artificial_analysis` | [Optional[components.AABenchmarkEntry]](../components/aabenchmarkentry.mdx) | :heavy_minus_sign: | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | -| `design_arena` | List[[components.DABenchmarkEntry](../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 +| `artificial_analysis` | [Optional[components.AABenchmarkEntry]](../components/aabenchmarkentry.mdx) | ➖ | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | +| `design_arena` | List[[components.DABenchmarkEntry](../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/components/modellinks.mdx b/docs/components/modellinks.mdx index 2a6259988..5a4272b28 100644 --- a/docs/components/modellinks.mdx +++ b/docs/components/modellinks.mdx @@ -9,4 +9,4 @@ Related API endpoints and resources for this model. | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `details` | *str* | :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` | *str* | ✅ | 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/components/modelreasoning.mdx b/docs/components/modelreasoning.mdx index b8d23642d..000ea73e6 100644 --- a/docs/components/modelreasoning.mdx +++ b/docs/components/modelreasoning.mdx @@ -9,8 +9,8 @@ Reasoning effort configuration. Omitted for non-reasoning models and dynamic rou | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `default_effort` | [OptionalNullable[components.DefaultEffort]](../components/defaulteffort.mdx) | :heavy_minus_sign: | N/A | medium | -| `default_enabled` | *Optional[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. | | -| `supported_efforts` | List[[Nullable[components.ReasoningEffort]](../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. | | -| `supports_max_tokens` | *Optional[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 +| `default_effort` | [OptionalNullable[components.DefaultEffort]](../components/defaulteffort.mdx) | ➖ | N/A | medium | +| `default_enabled` | *Optional[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. | | +| `supported_efforts` | List[[Nullable[components.ReasoningEffort]](../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. | | +| `supports_max_tokens` | *Optional[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/components/modelresponse.mdx b/docs/components/modelresponse.mdx index 9ced33061..1c5bbde62 100644 --- a/docs/components/modelresponse.mdx +++ b/docs/components/modelresponse.mdx @@ -9,4 +9,4 @@ Single model response | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Model](../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](../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/components/modelscountresponse.mdx b/docs/components/modelscountresponse.mdx index 104a32fd7..ff98324e0 100644 --- a/docs/components/modelscountresponse.mdx +++ b/docs/components/modelscountresponse.mdx @@ -9,4 +9,4 @@ Model count data | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | [components.ModelsCountResponseData](../components/modelscountresponsedata.mdx) | :heavy_check_mark: | Model count data | \{
"count": 150
} | \ No newline at end of file +| `data` | [components.ModelsCountResponseData](../components/modelscountresponsedata.mdx) | ✅ | Model count data | \{
"count": 150
} | \ No newline at end of file diff --git a/docs/components/modelscountresponsedata.mdx b/docs/components/modelscountresponsedata.mdx index 9e1b9145d..0cace4a6a 100644 --- a/docs/components/modelscountresponsedata.mdx +++ b/docs/components/modelscountresponsedata.mdx @@ -9,4 +9,4 @@ Model count data | Field | Type | Required | Description | Example | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `count` | *int* | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file +| `count` | *int* | ✅ | Total number of available models | 150 | \ No newline at end of file diff --git a/docs/components/modelslistresponse.mdx b/docs/components/modelslistresponse.mdx index 505a1c073..9e9ab4cd5 100644 --- a/docs/components/modelslistresponse.mdx +++ b/docs/components/modelslistresponse.mdx @@ -9,6 +9,6 @@ List of available models | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.Model](../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](../components/modelslistresponselinks.mdx) | :heavy_check_mark: | Pagination links | | -| `total_count` | *int* | :heavy_check_mark: | Total number of models matching the query | 150 | \ No newline at end of file +| `data` | List[[components.Model](../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](../components/modelslistresponselinks.mdx) | ✅ | Pagination links | | +| `total_count` | *int* | ✅ | Total number of models matching the query | 150 | \ No newline at end of file diff --git a/docs/components/modelslistresponselinks.mdx b/docs/components/modelslistresponselinks.mdx index 4c3a50213..4b24a85e3 100644 --- a/docs/components/modelslistresponselinks.mdx +++ b/docs/components/modelslistresponselinks.mdx @@ -9,4 +9,4 @@ Pagination links | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `next` | *Nullable[str]* | :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` | *Nullable[str]* | ✅ | 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/components/moderationplugin.mdx b/docs/components/moderationplugin.mdx index 0fd2af65a..5a075c416 100644 --- a/docs/components/moderationplugin.mdx +++ b/docs/components/moderationplugin.mdx @@ -6,4 +6,4 @@ title: "ModerationPlugin" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `id` | [components.ModerationPluginID](../components/moderationpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `id` | [components.ModerationPluginID](../components/moderationpluginid.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/multimodalmedia.mdx b/docs/components/multimodalmedia.mdx index 9b621c1cc..72ae5e60d 100644 --- a/docs/components/multimodalmedia.mdx +++ b/docs/components/multimodalmedia.mdx @@ -6,5 +6,5 @@ title: "MultimodalMedia" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `data` | *str* | :heavy_check_mark: | N/A | -| `format_` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `data` | *str* | ✅ | N/A | +| `format_` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/namespacefunctiontool.mdx b/docs/components/namespacefunctiontool.mdx index 3fea9cdfb..c58d9d82f 100644 --- a/docs/components/namespacefunctiontool.mdx +++ b/docs/components/namespacefunctiontool.mdx @@ -9,12 +9,12 @@ A function tool grouped inside a namespace tool | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_callers` | List[[components.NamespaceFunctionToolAllowedCaller](../components/namespacefunctiontoolallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `type` | [components.NamespaceFunctionToolType](../components/namespacefunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowed_callers` | List[[components.NamespaceFunctionToolAllowedCaller](../components/namespacefunctiontoolallowedcaller.mdx)] | ➖ | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | ➖ | N/A | | +| `description` | *OptionalNullable[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | +| `parameters` | Dict[str, *Any*] | ➖ | N/A | | +| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | +| `type` | [components.NamespaceFunctionToolType](../components/namespacefunctiontooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/namespacetool.mdx b/docs/components/namespacetool.mdx index fab5a7cce..d00413cfe 100644 --- a/docs/components/namespacetool.mdx +++ b/docs/components/namespacetool.mdx @@ -9,7 +9,7 @@ Groups function/custom tools under a shared namespace | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `description` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `tools` | List[[components.NamespaceToolTool](../components/namespacetooltool.mdx)] | :heavy_check_mark: | N/A | -| `type` | [components.NamespaceToolType](../components/namespacetooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `description` | *str* | ✅ | N/A | +| `name` | *str* | ✅ | N/A | +| `tools` | List[[components.NamespaceToolTool](../components/namespacetooltool.mdx)] | ✅ | N/A | +| `type` | [components.NamespaceToolType](../components/namespacetooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/nativesupport.mdx b/docs/components/nativesupport.mdx index a45fc5f12..57e8500c7 100644 --- a/docs/components/nativesupport.mdx +++ b/docs/components/nativesupport.mdx @@ -9,6 +9,6 @@ Endpoints whose provider runs this tool itself during inference. Zero for tools | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `endpoint_count` | *int* | :heavy_check_mark: | N/A | 18 | -| `model_count` | *int* | :heavy_check_mark: | N/A | 12 | -| `models` | List[[components.ServerToolNativeModel](../components/servertoolnativemodel.mdx)] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `endpoint_count` | *int* | ✅ | N/A | 18 | +| `model_count` | *int* | ✅ | N/A | 12 | +| `models` | List[[components.ServerToolNativeModel](../components/servertoolnativemodel.mdx)] | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/nativetools.mdx b/docs/components/nativetools.mdx index f578f85cd..57c9b4dd1 100644 --- a/docs/components/nativetools.mdx +++ b/docs/components/nativetools.mdx @@ -6,4 +6,4 @@ title: "NativeTools" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *str* | :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` | *str* | ✅ | 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/components/never.mdx b/docs/components/never.mdx index 37ce7d365..41a96792c 100644 --- a/docs/components/never.mdx +++ b/docs/components/never.mdx @@ -6,4 +6,4 @@ title: "Never" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `tool_names` | List[*str*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/notfoundresponseerrordata.mdx b/docs/components/notfoundresponseerrordata.mdx index e0bc365ca..e564eb88e 100644 --- a/docs/components/notfoundresponseerrordata.mdx +++ b/docs/components/notfoundresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for NotFoundResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/oauthjwks.mdx b/docs/components/oauthjwks.mdx index 463ee9cd6..2c6972233 100644 --- a/docs/components/oauthjwks.mdx +++ b/docs/components/oauthjwks.mdx @@ -9,4 +9,4 @@ RFC 7517 JWK Set of the keys OpenRouter signs access tokens with. | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `keys` | List[[components.Key](../components/key.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `keys` | List[[components.Key](../components/key.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilityarizedestination.mdx b/docs/components/observabilityarizedestination.mdx index 81b38c7eb..16ad5585d 100644 --- a/docs/components/observabilityarizedestination.mdx +++ b/docs/components/observabilityarizedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityArizeDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityArizeDestinationConfig](../components/observabilityarizedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityArizeDestinationType](../components/observabilityarizedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityArizeDestinationConfig](../components/observabilityarizedestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityArizeDestinationType](../components/observabilityarizedestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilityarizedestinationconfig.mdx b/docs/components/observabilityarizedestinationconfig.mdx index 9a4f66bee..e4a03087d 100644 --- a/docs/components/observabilityarizedestinationconfig.mdx +++ b/docs/components/observabilityarizedestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityArizeDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `model_id` | *str* | :heavy_check_mark: | The name of the tracing project in Arize AX | -| `space_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `api_key` | *str* | ✅ | N/A | +| `base_url` | *Optional[str]* | ➖ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `model_id` | *str* | ✅ | The name of the tracing project in Arize AX | +| `space_key` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilitybraintrustdestination.mdx b/docs/components/observabilitybraintrustdestination.mdx index de01be166..f10debe55 100644 --- a/docs/components/observabilitybraintrustdestination.mdx +++ b/docs/components/observabilitybraintrustdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityBraintrustDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityBraintrustDestinationConfig](../components/observabilitybraintrustdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityBraintrustDestinationType](../components/observabilitybraintrustdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityBraintrustDestinationConfig](../components/observabilitybraintrustdestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityBraintrustDestinationType](../components/observabilitybraintrustdestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitybraintrustdestinationconfig.mdx b/docs/components/observabilitybraintrustdestinationconfig.mdx index 56fcb6232..0e4d24b7e 100644 --- a/docs/components/observabilitybraintrustdestinationconfig.mdx +++ b/docs/components/observabilitybraintrustdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityBraintrustDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `api_key` | *str* | ✅ | N/A | +| `base_url` | *Optional[str]* | ➖ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `project_id` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilityclickhousedestination.mdx b/docs/components/observabilityclickhousedestination.mdx index d1aa02d0d..3b810270a 100644 --- a/docs/components/observabilityclickhousedestination.mdx +++ b/docs/components/observabilityclickhousedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityClickhouseDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityClickhouseDestinationConfig](../components/observabilityclickhousedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityClickhouseDestinationType](../components/observabilityclickhousedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityClickhouseDestinationConfig](../components/observabilityclickhousedestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityClickhouseDestinationType](../components/observabilityclickhousedestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilityclickhousedestinationconfig.mdx b/docs/components/observabilityclickhousedestinationconfig.mdx index 1eac658c8..86a71c70f 100644 --- a/docs/components/observabilityclickhousedestinationconfig.mdx +++ b/docs/components/observabilityclickhousedestinationconfig.mdx @@ -6,10 +6,10 @@ title: "ObservabilityClickhouseDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `database` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `host` | *str* | :heavy_check_mark: | N/A | -| `password` | *str* | :heavy_check_mark: | N/A | -| `should_include_cache_write_tokens` | *Optional[bool]* | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `table` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `username` | *str* | :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` | *str* | ✅ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `host` | *str* | ✅ | N/A | +| `password` | *str* | ✅ | N/A | +| `should_include_cache_write_tokens` | *Optional[bool]* | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `table` | *Optional[str]* | ➖ | N/A | +| `username` | *str* | ✅ | 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/components/observabilitydatadogdestination.mdx b/docs/components/observabilitydatadogdestination.mdx index 72f0faa27..b13db94b2 100644 --- a/docs/components/observabilitydatadogdestination.mdx +++ b/docs/components/observabilitydatadogdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityDatadogDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityDatadogDestinationConfig](../components/observabilitydatadogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityDatadogDestinationType](../components/observabilitydatadogdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityDatadogDestinationConfig](../components/observabilitydatadogdestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityDatadogDestinationType](../components/observabilitydatadogdestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitydatadogdestinationconfig.mdx b/docs/components/observabilitydatadogdestinationconfig.mdx index ed2b5c529..acee481b5 100644 --- a/docs/components/observabilitydatadogdestinationconfig.mdx +++ b/docs/components/observabilitydatadogdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityDatadogDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | Datadog API key must have LLM Observability permissions. Create at: | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `ml_app` | *str* | :heavy_check_mark: | Name to identify your application in Datadog LLM Observability | -| `url` | *Optional[str]* | :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 +| `api_key` | *str* | ✅ | Datadog API key must have LLM Observability permissions. Create at: | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `ml_app` | *str* | ✅ | Name to identify your application in Datadog LLM Observability | +| `url` | *Optional[str]* | ➖ | 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/components/observabilityfilterrulegroup.mdx b/docs/components/observabilityfilterrulegroup.mdx index 95aa7cfb8..bd9dc6dae 100644 --- a/docs/components/observabilityfilterrulegroup.mdx +++ b/docs/components/observabilityfilterrulegroup.mdx @@ -6,5 +6,5 @@ title: "ObservabilityFilterRuleGroup" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `logic` | [Optional[components.Logic]](../components/logic.mdx) | :heavy_minus_sign: | N/A | -| `rules` | List[[components.Rule](../components/rule.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `logic` | [Optional[components.Logic]](../components/logic.mdx) | ➖ | N/A | +| `rules` | List[[components.Rule](../components/rule.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilityfilterrulesconfig.mdx b/docs/components/observabilityfilterrulesconfig.mdx index 839340442..c8676edbb 100644 --- a/docs/components/observabilityfilterrulesconfig.mdx +++ b/docs/components/observabilityfilterrulesconfig.mdx @@ -9,5 +9,5 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `groups` | List[[components.ObservabilityFilterRuleGroup](../components/observabilityfilterrulegroup.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | ➖ | N/A | +| `groups` | List[[components.ObservabilityFilterRuleGroup](../components/observabilityfilterrulegroup.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilityfilterrulesconfignullable.mdx b/docs/components/observabilityfilterrulesconfignullable.mdx index 842fa8f78..d3f087caa 100644 --- a/docs/components/observabilityfilterrulesconfignullable.mdx +++ b/docs/components/observabilityfilterrulesconfignullable.mdx @@ -9,5 +9,5 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `groups` | List[[components.ObservabilityFilterRuleGroup](../components/observabilityfilterrulegroup.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | ➖ | N/A | +| `groups` | List[[components.ObservabilityFilterRuleGroup](../components/observabilityfilterrulegroup.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilitygrafanadestination.mdx b/docs/components/observabilitygrafanadestination.mdx index 74004a3f8..d2628a53e 100644 --- a/docs/components/observabilitygrafanadestination.mdx +++ b/docs/components/observabilitygrafanadestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityGrafanaDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityGrafanaDestinationConfig](../components/observabilitygrafanadestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityGrafanaDestinationType](../components/observabilitygrafanadestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityGrafanaDestinationConfig](../components/observabilitygrafanadestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityGrafanaDestinationType](../components/observabilitygrafanadestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitygrafanadestinationconfig.mdx b/docs/components/observabilitygrafanadestinationconfig.mdx index 34d561c25..04e0fb4b0 100644 --- a/docs/components/observabilitygrafanadestinationconfig.mdx +++ b/docs/components/observabilitygrafanadestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityGrafanaDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `instance_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `api_key` | *str* | ✅ | N/A | +| `base_url` | *Optional[str]* | ➖ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `instance_id` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilitylangfusedestination.mdx b/docs/components/observabilitylangfusedestination.mdx index d3acd28ab..44a61473f 100644 --- a/docs/components/observabilitylangfusedestination.mdx +++ b/docs/components/observabilitylangfusedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityLangfuseDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityLangfuseDestinationConfig](../components/observabilitylangfusedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityLangfuseDestinationType](../components/observabilitylangfusedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityLangfuseDestinationConfig](../components/observabilitylangfusedestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityLangfuseDestinationType](../components/observabilitylangfusedestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitylangfusedestinationconfig.mdx b/docs/components/observabilitylangfusedestinationconfig.mdx index cabadb292..359cd2576 100644 --- a/docs/components/observabilitylangfusedestinationconfig.mdx +++ b/docs/components/observabilitylangfusedestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityLangfuseDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `public_key` | *str* | :heavy_check_mark: | N/A | -| `secret_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `base_url` | *Optional[str]* | ➖ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `public_key` | *str* | ✅ | N/A | +| `secret_key` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilitylangsmithdestination.mdx b/docs/components/observabilitylangsmithdestination.mdx index a1fb2aaa0..d12830836 100644 --- a/docs/components/observabilitylangsmithdestination.mdx +++ b/docs/components/observabilitylangsmithdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityLangsmithDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityLangsmithDestinationConfig](../components/observabilitylangsmithdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityLangsmithDestinationType](../components/observabilitylangsmithdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityLangsmithDestinationConfig](../components/observabilitylangsmithdestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityLangsmithDestinationType](../components/observabilitylangsmithdestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitylangsmithdestinationconfig.mdx b/docs/components/observabilitylangsmithdestinationconfig.mdx index 0a1f76e5a..53bc63c7c 100644 --- a/docs/components/observabilitylangsmithdestinationconfig.mdx +++ b/docs/components/observabilitylangsmithdestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityLangsmithDestinationConfig" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `endpoint` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project` | *Optional[str]* | :heavy_minus_sign: | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file +| `api_key` | *str* | ✅ | N/A | +| `endpoint` | *Optional[str]* | ➖ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `project` | *Optional[str]* | ➖ | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | +| `workspace_id` | *Optional[str]* | ➖ | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file diff --git a/docs/components/observabilitynewrelicdestination.mdx b/docs/components/observabilitynewrelicdestination.mdx index 0865859d0..c4a4ea6c5 100644 --- a/docs/components/observabilitynewrelicdestination.mdx +++ b/docs/components/observabilitynewrelicdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityNewrelicDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityNewrelicDestinationConfig](../components/observabilitynewrelicdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityNewrelicDestinationType](../components/observabilitynewrelicdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityNewrelicDestinationConfig](../components/observabilitynewrelicdestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityNewrelicDestinationType](../components/observabilitynewrelicdestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitynewrelicdestinationconfig.mdx b/docs/components/observabilitynewrelicdestinationconfig.mdx index eb8542dca..99688937f 100644 --- a/docs/components/observabilitynewrelicdestinationconfig.mdx +++ b/docs/components/observabilitynewrelicdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityNewrelicDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `license_key` | *str* | :heavy_check_mark: | N/A | -| `region` | [Optional[components.Region]](../components/region.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `license_key` | *str* | ✅ | N/A | +| `region` | [Optional[components.Region]](../components/region.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/observabilityopikdestination.mdx b/docs/components/observabilityopikdestination.mdx index 31277388b..7be32b1f7 100644 --- a/docs/components/observabilityopikdestination.mdx +++ b/docs/components/observabilityopikdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityOpikDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityOpikDestinationConfig](../components/observabilityopikdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityOpikDestinationType](../components/observabilityopikdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityOpikDestinationConfig](../components/observabilityopikdestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityOpikDestinationType](../components/observabilityopikdestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilityopikdestinationconfig.mdx b/docs/components/observabilityopikdestinationconfig.mdx index ce71d1f16..97f79e6b8 100644 --- a/docs/components/observabilityopikdestinationconfig.mdx +++ b/docs/components/observabilityopikdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityOpikDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project_name` | *str* | :heavy_check_mark: | N/A | -| `workspace` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `api_key` | *str* | ✅ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `project_name` | *str* | ✅ | N/A | +| `workspace` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilityotelcollectordestination.mdx b/docs/components/observabilityotelcollectordestination.mdx index 3052cfc35..f4fec2071 100644 --- a/docs/components/observabilityotelcollectordestination.mdx +++ b/docs/components/observabilityotelcollectordestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityOtelCollectorDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityOtelCollectorDestinationConfig](../components/observabilityotelcollectordestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityOtelCollectorDestinationType](../components/observabilityotelcollectordestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityOtelCollectorDestinationConfig](../components/observabilityotelcollectordestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityOtelCollectorDestinationType](../components/observabilityotelcollectordestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilityotelcollectordestinationconfig.mdx b/docs/components/observabilityotelcollectordestinationconfig.mdx index c0e46e241..c625d1a95 100644 --- a/docs/components/observabilityotelcollectordestinationconfig.mdx +++ b/docs/components/observabilityotelcollectordestinationconfig.mdx @@ -6,5 +6,5 @@ title: "ObservabilityOtelCollectorDestinationConfig" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `endpoint` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :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` | *str* | ✅ | N/A | +| `headers` | Dict[str, *str*] | ➖ | 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/components/observabilityposthogdestination.mdx b/docs/components/observabilityposthogdestination.mdx index 0348a7d46..ce92982f5 100644 --- a/docs/components/observabilityposthogdestination.mdx +++ b/docs/components/observabilityposthogdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityPosthogDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityPosthogDestinationConfig](../components/observabilityposthogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityPosthogDestinationType](../components/observabilityposthogdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityPosthogDestinationConfig](../components/observabilityposthogdestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityPosthogDestinationType](../components/observabilityposthogdestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilityposthogdestinationconfig.mdx b/docs/components/observabilityposthogdestinationconfig.mdx index 2c0c48dee..8ed1df6aa 100644 --- a/docs/components/observabilityposthogdestinationconfig.mdx +++ b/docs/components/observabilityposthogdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityPosthogDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `endpoint` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file +| `api_key` | *str* | ✅ | N/A | +| `endpoint` | *Optional[str]* | ➖ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file diff --git a/docs/components/observabilityrampdestination.mdx b/docs/components/observabilityrampdestination.mdx index 43f146a50..45565dc9d 100644 --- a/docs/components/observabilityrampdestination.mdx +++ b/docs/components/observabilityrampdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityRampDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityRampDestinationConfig](../components/observabilityrampdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityRampDestinationType](../components/observabilityrampdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityRampDestinationConfig](../components/observabilityrampdestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityRampDestinationType](../components/observabilityrampdestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilityrampdestinationconfig.mdx b/docs/components/observabilityrampdestinationconfig.mdx index 809d417c9..a60daa343 100644 --- a/docs/components/observabilityrampdestinationconfig.mdx +++ b/docs/components/observabilityrampdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityRampDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | Generate this in your Ramp integration settings. | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file +| `api_key` | *str* | ✅ | Generate this in your Ramp integration settings. | +| `base_url` | *Optional[str]* | ➖ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file diff --git a/docs/components/observabilitys3destination.mdx b/docs/components/observabilitys3destination.mdx index 2de0187cd..4e44982ae 100644 --- a/docs/components/observabilitys3destination.mdx +++ b/docs/components/observabilitys3destination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityS3Destination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityS3DestinationConfig](../components/observabilitys3destinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityS3DestinationType](../components/observabilitys3destinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityS3DestinationConfig](../components/observabilitys3destinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityS3DestinationType](../components/observabilitys3destinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitys3destinationconfig.mdx b/docs/components/observabilitys3destinationconfig.mdx index 397420955..e6dfccca9 100644 --- a/docs/components/observabilitys3destinationconfig.mdx +++ b/docs/components/observabilitys3destinationconfig.mdx @@ -6,12 +6,12 @@ title: "ObservabilityS3DestinationConfig" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `access_key_id` | *str* | :heavy_check_mark: | N/A | -| `bucket_name` | *str* | :heavy_check_mark: | N/A | -| `endpoint` | *Optional[str]* | :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` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `path_template` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `region` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `secret_access_key` | *str* | :heavy_check_mark: | N/A | -| `session_token` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `access_key_id` | *str* | ✅ | N/A | +| `bucket_name` | *str* | ✅ | N/A | +| `endpoint` | *Optional[str]* | ➖ | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `path_template` | *Optional[str]* | ➖ | Template for S3 object path. The filename (\{traceId}-\{timestamp}.json) is automatically appended. Available variables: \{prefix}, \{date}, \{year}, \{month}, \{day}, \{apiKeyName} | +| `prefix` | *Optional[str]* | ➖ | N/A | +| `region` | *Optional[str]* | ➖ | N/A | +| `secret_access_key` | *str* | ✅ | N/A | +| `session_token` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/observabilitysentrydestination.mdx b/docs/components/observabilitysentrydestination.mdx index d61e0cbf1..bfd6c8e6c 100644 --- a/docs/components/observabilitysentrydestination.mdx +++ b/docs/components/observabilitysentrydestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilitySentryDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilitySentryDestinationConfig](../components/observabilitysentrydestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilitySentryDestinationType](../components/observabilitysentrydestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilitySentryDestinationConfig](../components/observabilitysentrydestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilitySentryDestinationType](../components/observabilitysentrydestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitysentrydestinationconfig.mdx b/docs/components/observabilitysentrydestinationconfig.mdx index 99f775de0..c2b828f39 100644 --- a/docs/components/observabilitysentrydestinationconfig.mdx +++ b/docs/components/observabilitysentrydestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilitySentryDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `dsn` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `otlp_endpoint` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `dsn` | *str* | ✅ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `otlp_endpoint` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilitysnowflakedestination.mdx b/docs/components/observabilitysnowflakedestination.mdx index 6625d5f95..6be7bcda4 100644 --- a/docs/components/observabilitysnowflakedestination.mdx +++ b/docs/components/observabilitysnowflakedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilitySnowflakeDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilitySnowflakeDestinationConfig](../components/observabilitysnowflakedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilitySnowflakeDestinationType](../components/observabilitysnowflakedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilitySnowflakeDestinationConfig](../components/observabilitysnowflakedestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilitySnowflakeDestinationType](../components/observabilitysnowflakedestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitysnowflakedestinationconfig.mdx b/docs/components/observabilitysnowflakedestinationconfig.mdx index a7b7e4788..60125bca6 100644 --- a/docs/components/observabilitysnowflakedestinationconfig.mdx +++ b/docs/components/observabilitysnowflakedestinationconfig.mdx @@ -6,11 +6,11 @@ title: "ObservabilitySnowflakeDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `account` | *str* | :heavy_check_mark: | N/A | -| `database` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `should_include_cache_write_tokens` | *Optional[bool]* | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `table` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `warehouse` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `account` | *str* | ✅ | N/A | +| `database` | *Optional[str]* | ➖ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `schema_` | *Optional[str]* | ➖ | N/A | +| `should_include_cache_write_tokens` | *Optional[bool]* | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `table` | *Optional[str]* | ➖ | N/A | +| `token` | *str* | ✅ | N/A | +| `warehouse` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/observabilityweavedestination.mdx b/docs/components/observabilityweavedestination.mdx index b60a11276..7579a2c79 100644 --- a/docs/components/observabilityweavedestination.mdx +++ b/docs/components/observabilityweavedestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityWeaveDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityWeaveDestinationConfig](../components/observabilityweavedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityWeaveDestinationType](../components/observabilityweavedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityWeaveDestinationConfig](../components/observabilityweavedestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityWeaveDestinationType](../components/observabilityweavedestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilityweavedestinationconfig.mdx b/docs/components/observabilityweavedestinationconfig.mdx index 890078548..9a47f314c 100644 --- a/docs/components/observabilityweavedestinationconfig.mdx +++ b/docs/components/observabilityweavedestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityWeaveDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `entity` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `api_key` | *str* | ✅ | N/A | +| `base_url` | *Optional[str]* | ➖ | N/A | +| `entity` | *str* | ✅ | N/A | +| `headers` | Dict[str, *str*] | ➖ | Custom HTTP headers to include in requests to this destination. | +| `project` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/observabilitywebhookdestination.mdx b/docs/components/observabilitywebhookdestination.mdx index 9476e2dbd..2c7e94483 100644 --- a/docs/components/observabilitywebhookdestination.mdx +++ b/docs/components/observabilitywebhookdestination.mdx @@ -6,20 +6,20 @@ title: "ObservabilityWebhookDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *bool* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *bool* | :heavy_check_mark: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *bool* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *bool* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [components.ObservabilityWebhookDestinationConfig](../components/observabilitywebhookdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegion](../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"
] | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityWebhookDestinationType](../components/observabilitywebhookdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcast_generation_cost` | *bool* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *bool* | ✅ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *bool* | ✅ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *bool* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [components.ObservabilityWebhookDestinationConfig](../components/observabilitywebhookdestinationconfig.mdx) | ✅ | N/A | | +| `created_at` | *str* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *bool* | ✅ | Whether this destination is currently enabled. | true | +| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *str* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *Nullable[str]* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *bool* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegion](../components/observabilitydataregion.mdx)] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `sampling_rate` | *float* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [components.ObservabilityWebhookDestinationType](../components/observabilitywebhookdestinationtype.mdx) | ✅ | N/A | | +| `updated_at` | *str* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/observabilitywebhookdestinationconfig.mdx b/docs/components/observabilitywebhookdestinationconfig.mdx index 8dab0b1a2..b05354574 100644 --- a/docs/components/observabilitywebhookdestinationconfig.mdx +++ b/docs/components/observabilitywebhookdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityWebhookDestinationConfig" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | N/A | -| `method` | [Optional[components.Method]](../components/method.mdx) | :heavy_minus_sign: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `headers` | Dict[str, *str*] | ➖ | N/A | +| `method` | [Optional[components.Method]](../components/method.mdx) | ➖ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openaifile.mdx b/docs/components/openaifile.mdx index 83aa79140..6f7c92c6f 100644 --- a/docs/components/openaifile.mdx +++ b/docs/components/openaifile.mdx @@ -9,11 +9,11 @@ A stored file in OpenAI's Files API shape. | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `shape` | [components.OpenAIFileShape](../components/openaifileshape.mdx) | :heavy_check_mark: | N/A | -| `bytes_` | *int* | :heavy_check_mark: | N/A | -| `created_at` | *int* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `object` | [components.OpenAIFileObject](../components/openaifileobject.mdx) | :heavy_check_mark: | N/A | -| `purpose` | [components.Purpose](../components/purpose.mdx) | :heavy_check_mark: | N/A | -| `status` | [components.OpenAIFileStatus](../components/openaifilestatus.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [components.OpenAIFileShape](../components/openaifileshape.mdx) | ✅ | N/A | +| `bytes_` | *int* | ✅ | N/A | +| `created_at` | *int* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `object` | [components.OpenAIFileObject](../components/openaifileobject.mdx) | ✅ | N/A | +| `purpose` | [components.Purpose](../components/purpose.mdx) | ✅ | N/A | +| `status` | [components.OpenAIFileStatus](../components/openaifilestatus.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openaifiledeleted.mdx b/docs/components/openaifiledeleted.mdx index 24db73f81..d8fcb6ae6 100644 --- a/docs/components/openaifiledeleted.mdx +++ b/docs/components/openaifiledeleted.mdx @@ -9,7 +9,7 @@ Deletion result in OpenAI's shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `shape` | [components.OpenAIFileDeletedShape](../components/openaifiledeletedshape.mdx) | :heavy_check_mark: | N/A | -| `deleted` | *Literal[True]* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `object` | [components.OpenAIFileDeletedObject](../components/openaifiledeletedobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [components.OpenAIFileDeletedShape](../components/openaifiledeletedshape.mdx) | ✅ | N/A | +| `deleted` | *Literal[True]* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `object` | [components.OpenAIFileDeletedObject](../components/openaifiledeletedobject.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openaifilelist.mdx b/docs/components/openaifilelist.mdx index d365da303..b31e5333c 100644 --- a/docs/components/openaifilelist.mdx +++ b/docs/components/openaifilelist.mdx @@ -9,9 +9,9 @@ A page of files in OpenAI's shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `shape` | [components.OpenAIFileListShape](../components/openaifilelistshape.mdx) | :heavy_check_mark: | N/A | -| `data` | List[[components.OpenAIFile](../components/openaifile.mdx)] | :heavy_check_mark: | N/A | -| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `has_more` | *bool* | :heavy_check_mark: | N/A | -| `last_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `object` | [components.OpenAIFileListObject](../components/openaifilelistobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [components.OpenAIFileListShape](../components/openaifilelistshape.mdx) | ✅ | N/A | +| `data` | List[[components.OpenAIFile](../components/openaifile.mdx)] | ✅ | N/A | +| `first_id` | *Nullable[str]* | ✅ | N/A | +| `has_more` | *bool* | ✅ | N/A | +| `last_id` | *Nullable[str]* | ✅ | N/A | +| `object` | [components.OpenAIFileListObject](../components/openaifilelistobject.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsecustomtoolcall.mdx b/docs/components/openairesponsecustomtoolcall.mdx index fdcac04a3..77290a83c 100644 --- a/docs/components/openairesponsecustomtoolcall.mdx +++ b/docs/components/openairesponsecustomtoolcall.mdx @@ -6,10 +6,10 @@ title: "OpenAIResponseCustomToolCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `async_` | *Optional[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 | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `input` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `type` | [components.OpenAIResponseCustomToolCallType](../components/openairesponsecustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async_` | *Optional[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 | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `input` | *str* | ✅ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `type` | [components.OpenAIResponseCustomToolCallType](../components/openairesponsecustomtoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/openairesponsecustomtoolcalloutput.mdx b/docs/components/openairesponsecustomtoolcalloutput.mdx index a5539655b..e3440b286 100644 --- a/docs/components/openairesponsecustomtoolcalloutput.mdx +++ b/docs/components/openairesponsecustomtoolcalloutput.mdx @@ -6,7 +6,7 @@ title: "OpenAIResponseCustomToolCallOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../components/openairesponsecustomtoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.OpenAIResponseCustomToolCallOutputType](../components/openairesponsecustomtoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | +| `id` | *Optional[str]* | ➖ | N/A | +| `output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../components/openairesponsecustomtoolcalloutputoutput2.mdx) | ✅ | N/A | +| `type` | [components.OpenAIResponseCustomToolCallOutputType](../components/openairesponsecustomtoolcalloutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsefunctiontoolcall.mdx b/docs/components/openairesponsefunctiontoolcall.mdx index 4624a3966..e53b990fd 100644 --- a/docs/components/openairesponsefunctiontoolcall.mdx +++ b/docs/components/openairesponsefunctiontoolcall.mdx @@ -6,13 +6,13 @@ title: "OpenAIResponseFunctionToolCall" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | N/A | | -| `async_` | *Optional[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 | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `subagent_id` | *Optional[str]* | :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. | | -| `subagent_items` | List[[components.OpenAIResponseFunctionToolCallSubagentItem](../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](../components/openairesponsefunctiontoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | | +| `async_` | *Optional[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 | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | +| `subagent_id` | *Optional[str]* | ➖ | 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. | | +| `subagent_items` | List[[components.OpenAIResponseFunctionToolCallSubagentItem](../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](../components/openairesponsefunctiontoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/openairesponsefunctiontoolcalloutput.mdx b/docs/components/openairesponsefunctiontoolcalloutput.mdx index 7999eeee6..bab1a9547 100644 --- a/docs/components/openairesponsefunctiontoolcalloutput.mdx +++ b/docs/components/openairesponsefunctiontoolcalloutput.mdx @@ -6,8 +6,8 @@ title: "OpenAIResponseFunctionToolCallOutput" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../components/openairesponsefunctiontoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.OpenAIResponseFunctionToolCallOutputType](../components/openairesponsefunctiontoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../components/openairesponsefunctiontoolcalloutputoutput2.mdx) | ✅ | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [components.OpenAIResponseFunctionToolCallOutputType](../components/openairesponsefunctiontoolcalloutputtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/openairesponsefunctiontoolcallsubagentitem.mdx b/docs/components/openairesponsefunctiontoolcallsubagentitem.mdx index b52ff9cb9..bdfd1e48d 100644 --- a/docs/components/openairesponsefunctiontoolcallsubagentitem.mdx +++ b/docs/components/openairesponsefunctiontoolcallsubagentitem.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponseFunctionToolCallSubagentItem" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *str* | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/openairesponseinputmessageitem.mdx b/docs/components/openairesponseinputmessageitem.mdx index 8670ec0c1..1f5c248d0 100644 --- a/docs/components/openairesponseinputmessageitem.mdx +++ b/docs/components/openairesponseinputmessageitem.mdx @@ -6,7 +6,7 @@ title: "OpenAIResponseInputMessageItem" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.OpenAIResponseInputMessageItemContent](../components/openairesponseinputmessageitemcontent.mdx)] | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `role` | [components.OpenAIResponseInputMessageItemRoleUnion](../components/openairesponseinputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | -| `type` | [Optional[components.OpenAIResponseInputMessageItemType]](../components/openairesponseinputmessageitemtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | List[[components.OpenAIResponseInputMessageItemContent](../components/openairesponseinputmessageitemcontent.mdx)] | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `role` | [components.OpenAIResponseInputMessageItemRoleUnion](../components/openairesponseinputmessageitemroleunion.mdx) | ✅ | N/A | +| `type` | [Optional[components.OpenAIResponseInputMessageItemType]](../components/openairesponseinputmessageitemtype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsesrefusalcontent.mdx b/docs/components/openairesponsesrefusalcontent.mdx index c687dab46..de50c56bc 100644 --- a/docs/components/openairesponsesrefusalcontent.mdx +++ b/docs/components/openairesponsesrefusalcontent.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponsesRefusalContent" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `refusal` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.OpenAIResponsesRefusalContentType](../components/openairesponsesrefusalcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `refusal` | *str* | ✅ | N/A | +| `type` | [components.OpenAIResponsesRefusalContentType](../components/openairesponsesrefusalcontenttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsestoolchoice.mdx b/docs/components/openairesponsestoolchoice.mdx index 71090a1f7..bf509f6e0 100644 --- a/docs/components/openairesponsestoolchoice.mdx +++ b/docs/components/openairesponsestoolchoice.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoice" | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | [components.Type](../components/type.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.Type](../components/type.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsestoolchoiceapplypatch.mdx b/docs/components/openairesponsestoolchoiceapplypatch.mdx index de012d5c1..c195661a9 100644 --- a/docs/components/openairesponsestoolchoiceapplypatch.mdx +++ b/docs/components/openairesponsestoolchoiceapplypatch.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceApplyPatch" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../components/openairesponsestoolchoicetypeapplypatch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../components/openairesponsestoolchoicetypeapplypatch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsestoolchoicefunction.mdx b/docs/components/openairesponsestoolchoicefunction.mdx index e08dad52c..622d91c05 100644 --- a/docs/components/openairesponsestoolchoicefunction.mdx +++ b/docs/components/openairesponsestoolchoicefunction.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponsesToolChoiceFunction" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.OpenAIResponsesToolChoiceTypeFunction](../components/openairesponsestoolchoicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *str* | ✅ | N/A | +| `type` | [components.OpenAIResponsesToolChoiceTypeFunction](../components/openairesponsestoolchoicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openairesponsestoolchoiceshell.mdx b/docs/components/openairesponsestoolchoiceshell.mdx index b0451b76a..a8af8c0ab 100644 --- a/docs/components/openairesponsestoolchoiceshell.mdx +++ b/docs/components/openairesponsestoolchoiceshell.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceShell" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesToolChoiceTypeShell](../components/openairesponsestoolchoicetypeshell.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.OpenAIResponsesToolChoiceTypeShell](../components/openairesponsestoolchoicetypeshell.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openresponsescreatedevent.mdx b/docs/components/openresponsescreatedevent.mdx index f1b2f4719..75a6a54d5 100644 --- a/docs/components/openresponsescreatedevent.mdx +++ b/docs/components/openresponsescreatedevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is created | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.OpenResponsesCreatedEventType](../components/openresponsescreatedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | ✅ | N/A | | +| `type` | [components.OpenResponsesCreatedEventType](../components/openresponsescreatedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/openresponseserrorfield.mdx b/docs/components/openresponseserrorfield.mdx index 08c26185f..b1640dbc5 100644 --- a/docs/components/openresponseserrorfield.mdx +++ b/docs/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](../components/codeenum.mdx) | :heavy_check_mark: | N/A | | -| `message` | *str* | :heavy_check_mark: | N/A | | -| `metadata` | [Optional[components.OpenResponsesErrorMetadata]](../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](../components/codeenum.mdx) | ✅ | N/A | | +| `message` | *str* | ✅ | N/A | | +| `metadata` | [Optional[components.OpenResponsesErrorMetadata]](../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/components/openresponseserrormetadata.mdx b/docs/components/openresponseserrormetadata.mdx index 66dc83a39..770616c24 100644 --- a/docs/components/openresponseserrormetadata.mdx +++ b/docs/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` | [Optional[components.OpenResponsesErrorMetadataAlignment]](../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` | [Optional[components.OpenResponsesErrorMetadataAlignment]](../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/components/openresponseserrormetadataalignment.mdx b/docs/components/openresponseserrormetadataalignment.mdx index 2f63ffbaf..069d86984 100644 --- a/docs/components/openresponseserrormetadataalignment.mdx +++ b/docs/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` | List[[components.AlignmentCallRecord](../components/alignmentcallrecord.mdx)] | :heavy_check_mark: | One record per evaluated assistant message of the request, in the order the messages were produced. | -| `rejected` | [Optional[components.AlignmentRejected]](../components/alignmentrejected.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `calls` | List[[components.AlignmentCallRecord](../components/alignmentcallrecord.mdx)] | ✅ | One record per evaluated assistant message of the request, in the order the messages were produced. | +| `rejected` | [Optional[components.AlignmentRejected]](../components/alignmentrejected.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/openresponsesinprogressevent.mdx b/docs/components/openresponsesinprogressevent.mdx index b9c8edc51..a8ce87cc2 100644 --- a/docs/components/openresponsesinprogressevent.mdx +++ b/docs/components/openresponsesinprogressevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is in progress | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.OpenResponsesInProgressEventType](../components/openresponsesinprogresseventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | ✅ | N/A | | +| `type` | [components.OpenResponsesInProgressEventType](../components/openresponsesinprogresseventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/openresponsesresult.mdx b/docs/components/openresponsesresult.mdx index 31242e845..aae638dc4 100644 --- a/docs/components/openresponsesresult.mdx +++ b/docs/components/openresponsesresult.mdx @@ -9,41 +9,41 @@ Complete non-streaming response from the Responses API | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `completed_at` | *Nullable[int]* | :heavy_check_mark: | N/A | | -| `created_at` | *int* | :heavy_check_mark: | N/A | | -| `error` | [Nullable[components.OpenResponsesErrorField]](../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"
}
]
}
}
} | -| `frequency_penalty` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `incomplete_details` | [Nullable[components.IncompleteDetails]](../components/incompletedetails.mdx) | :heavy_check_mark: | N/A | \{
"reason": "max_output_tokens"
} | -| `instructions` | [Nullable[components.BaseInputsUnion]](../components/baseinputsunion.mdx) | :heavy_check_mark: | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | -| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `metadata` | Dict[str, *str*] | :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` | *str* | :heavy_check_mark: | N/A | | -| `object` | [components.OpenResponsesResultObject](../components/openresponsesresultobject.mdx) | :heavy_check_mark: | N/A | | -| `output` | List[[components.OutputItems](../components/outputitems.mdx)] | :heavy_check_mark: | N/A | | -| `output_text` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *bool* | :heavy_check_mark: | N/A | | -| `presence_penalty` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `previous_response_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt` | [OptionalNullable[components.StoredPromptTemplate]](../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.BaseReasoningConfig]](../components/basereasoningconfig.mdx) | :heavy_minus_sign: | N/A | \{
"effort": "medium",
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.OpenAIResponsesResponseStatus](../components/openairesponsesresponsestatus.mdx) | :heavy_check_mark: | N/A | completed | -| `store` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `temperature` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [components.OpenAIResponsesToolChoiceUnion](../components/openairesponsestoolchoiceunion.mdx) | :heavy_check_mark: | N/A | auto | -| `tools` | List[[components.OpenResponsesResultToolUnion](../components/openresponsesresulttoolunion.mdx)] | :heavy_check_mark: | N/A | | -| `top_logprobs` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `truncation` | [OptionalNullable[components.Truncation]](../components/truncation.mdx) | :heavy_minus_sign: | N/A | auto | -| `usage` | [OptionalNullable[components.Usage]](../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[str]* | :heavy_minus_sign: | N/A | | -| `alignment` | [Optional[components.Alignment]](../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
}
]
}
]
} | -| `error_type` | [Optional[components.APIErrorType]](../components/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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[bool]* | ➖ | N/A | | +| `completed_at` | *Nullable[int]* | ✅ | N/A | | +| `created_at` | *int* | ✅ | N/A | | +| `error` | [Nullable[components.OpenResponsesErrorField]](../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"
}
]
}
}
} | +| `frequency_penalty` | *Nullable[float]* | ✅ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `incomplete_details` | [Nullable[components.IncompleteDetails]](../components/incompletedetails.mdx) | ✅ | N/A | \{
"reason": "max_output_tokens"
} | +| `instructions` | [Nullable[components.BaseInputsUnion]](../components/baseinputsunion.mdx) | ✅ | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | ➖ | N/A | | +| `metadata` | Dict[str, *str*] | ✅ | 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` | *str* | ✅ | N/A | | +| `object` | [components.OpenResponsesResultObject](../components/openresponsesresultobject.mdx) | ✅ | N/A | | +| `output` | List[[components.OutputItems](../components/outputitems.mdx)] | ✅ | N/A | | +| `output_text` | *Optional[str]* | ➖ | N/A | | +| `parallel_tool_calls` | *bool* | ✅ | N/A | | +| `presence_penalty` | *Nullable[float]* | ✅ | N/A | | +| `previous_response_id` | *OptionalNullable[str]* | ➖ | N/A | | +| `prompt` | [OptionalNullable[components.StoredPromptTemplate]](../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.BaseReasoningConfig]](../components/basereasoningconfig.mdx) | ➖ | N/A | \{
"effort": "medium",
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | ➖ | N/A | | +| `service_tier` | *OptionalNullable[str]* | ➖ | N/A | | +| `status` | [components.OpenAIResponsesResponseStatus](../components/openairesponsesresponsestatus.mdx) | ✅ | N/A | completed | +| `store` | *Optional[bool]* | ➖ | N/A | | +| `temperature` | *Nullable[float]* | ✅ | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [components.OpenAIResponsesToolChoiceUnion](../components/openairesponsestoolchoiceunion.mdx) | ✅ | N/A | auto | +| `tools` | List[[components.OpenResponsesResultToolUnion](../components/openresponsesresulttoolunion.mdx)] | ✅ | N/A | | +| `top_logprobs` | *Optional[int]* | ➖ | N/A | | +| `top_p` | *Nullable[float]* | ✅ | N/A | | +| `truncation` | [OptionalNullable[components.Truncation]](../components/truncation.mdx) | ➖ | N/A | auto | +| `usage` | [OptionalNullable[components.Usage]](../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[str]* | ➖ | N/A | | +| `alignment` | [Optional[components.Alignment]](../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
}
]
}
]
} | +| `error_type` | [Optional[components.APIErrorType]](../components/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../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/components/openresponsesresulttoolfunction.mdx b/docs/components/openresponsesresulttoolfunction.mdx index 69aaa0c46..c2334a7c2 100644 --- a/docs/components/openresponsesresulttoolfunction.mdx +++ b/docs/components/openresponsesresulttoolfunction.mdx @@ -9,12 +9,12 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `parameters` | Dict[str, *Any*] | :heavy_check_mark: | N/A | | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `type` | [components.OpenResponsesResultType](../components/openresponsesresulttype.mdx) | :heavy_check_mark: | N/A | | -| `allowed_callers` | List[[components.OpenResponsesResultAllowedCaller](../components/openresponsesresultallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | -| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `description` | *OptionalNullable[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `parameters` | Dict[str, *Any*] | ✅ | N/A | | +| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | +| `type` | [components.OpenResponsesResultType](../components/openresponsesresulttype.mdx) | ✅ | N/A | | +| `allowed_callers` | List[[components.OpenResponsesResultAllowedCaller](../components/openresponsesresultallowedcaller.mdx)] | ➖ | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | +| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/openrouterfile.mdx b/docs/components/openrouterfile.mdx index f7335e372..2e7cf2d42 100644 --- a/docs/components/openrouterfile.mdx +++ b/docs/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](../components/openrouterfileshape.mdx) | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `downloadable` | *bool* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `mime_type` | *str* | :heavy_check_mark: | N/A | -| `size_bytes` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.OpenRouterFileType](../components/openrouterfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [components.OpenRouterFileShape](../components/openrouterfileshape.mdx) | ✅ | N/A | +| `created_at` | *str* | ✅ | N/A | +| `downloadable` | *bool* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `mime_type` | *str* | ✅ | N/A | +| `size_bytes` | *int* | ✅ | N/A | +| `type` | [components.OpenRouterFileType](../components/openrouterfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openrouterfiledeleted.mdx b/docs/components/openrouterfiledeleted.mdx index af6a578a5..76e59c88d 100644 --- a/docs/components/openrouterfiledeleted.mdx +++ b/docs/components/openrouterfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in the OpenRouter shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `shape` | [components.OpenRouterFileDeletedShape](../components/openrouterfiledeletedshape.mdx) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.OpenRouterFileDeletedType](../components/openrouterfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [components.OpenRouterFileDeletedShape](../components/openrouterfiledeletedshape.mdx) | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `type` | [components.OpenRouterFileDeletedType](../components/openrouterfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openrouterfilelist.mdx b/docs/components/openrouterfilelist.mdx index 16ebdba6b..4dbafe0c4 100644 --- a/docs/components/openrouterfilelist.mdx +++ b/docs/components/openrouterfilelist.mdx @@ -9,9 +9,9 @@ A page of files in the OpenRouter shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `shape` | [components.OpenRouterFileListShape](../components/openrouterfilelistshape.mdx) | :heavy_check_mark: | N/A | -| `cursor` | *Nullable[str]* | :heavy_check_mark: | Opaque cursor for the next page; null when there are no more results. | -| `data` | List[[components.OpenRouterFile](../components/openrouterfile.mdx)] | :heavy_check_mark: | N/A | -| `first_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `has_more` | *bool* | :heavy_check_mark: | N/A | -| `last_id` | *Nullable[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [components.OpenRouterFileListShape](../components/openrouterfilelistshape.mdx) | ✅ | N/A | +| `cursor` | *Nullable[str]* | ✅ | Opaque cursor for the next page; null when there are no more results. | +| `data` | List[[components.OpenRouterFile](../components/openrouterfile.mdx)] | ✅ | N/A | +| `first_id` | *Nullable[str]* | ✅ | N/A | +| `has_more` | *bool* | ✅ | N/A | +| `last_id` | *Nullable[str]* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/openroutermetadata.mdx b/docs/components/openroutermetadata.mdx index 4cbe15712..c0c25946e 100644 --- a/docs/components/openroutermetadata.mdx +++ b/docs/components/openroutermetadata.mdx @@ -6,14 +6,14 @@ title: "OpenRouterMetadata" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `attempt` | *int* | :heavy_check_mark: | N/A | | -| `attempts` | List[[components.RouterAttempt](../components/routerattempt.mdx)] | :heavy_minus_sign: | N/A | | -| `endpoints` | [components.EndpointsMetadata](../components/endpointsmetadata.mdx) | :heavy_check_mark: | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | -| `generation_time` | *Optional[int]* | :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 | -| `is_byok` | *bool* | :heavy_check_mark: | N/A | | -| `params` | [Optional[components.RouterParams]](../components/routerparams.mdx) | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | -| `pipeline` | List[[components.PipelineStage](../components/pipelinestage.mdx)] | :heavy_minus_sign: | N/A | | -| `region` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `requested` | *str* | :heavy_check_mark: | N/A | | -| `strategy` | [components.RoutingStrategy](../components/routingstrategy.mdx) | :heavy_check_mark: | N/A | direct | -| `summary` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `attempt` | *int* | ✅ | N/A | | +| `attempts` | List[[components.RouterAttempt](../components/routerattempt.mdx)] | ➖ | N/A | | +| `endpoints` | [components.EndpointsMetadata](../components/endpointsmetadata.mdx) | ✅ | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | +| `generation_time` | *Optional[int]* | ➖ | 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 | +| `is_byok` | *bool* | ✅ | N/A | | +| `params` | [Optional[components.RouterParams]](../components/routerparams.mdx) | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | +| `pipeline` | List[[components.PipelineStage](../components/pipelinestage.mdx)] | ➖ | N/A | | +| `region` | *Nullable[str]* | ✅ | N/A | | +| `requested` | *str* | ✅ | N/A | | +| `strategy` | [components.RoutingStrategy](../components/routingstrategy.mdx) | ✅ | N/A | direct | +| `summary` | *str* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/openrouterwebsearchservertool.mdx b/docs/components/openrouterwebsearchservertool.mdx index 3842a52e2..929334d2f 100644 --- a/docs/components/openrouterwebsearchservertool.mdx +++ b/docs/components/openrouterwebsearchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.WebSearchConfig]](../components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `type` | [components.OpenRouterWebSearchServerToolType](../components/openrouterwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.WebSearchConfig]](../components/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `type` | [components.OpenRouterWebSearchServerToolType](../components/openrouterwebsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/oranthropicbashtoolresult.mdx b/docs/components/oranthropicbashtoolresult.mdx index 4428fcec1..42292ca7c 100644 --- a/docs/components/oranthropicbashtoolresult.mdx +++ b/docs/components/oranthropicbashtoolresult.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:bash` call executed in the OpenRouter sandbox (`engine: | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *Optional[str]* | :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` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `files` | List[[components.ORAnthropicBashToolResultFile](../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. | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ORAnthropicBashToolResultTypeOpenrouterBashToolResult](../components/oranthropicbashtoolresulttypeopenrouterbashtoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *Optional[str]* | ➖ | 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` | Dict[str, *Any*] | ✅ | N/A | +| `files` | List[[components.ORAnthropicBashToolResultFile](../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. | +| `tool_use_id` | *str* | ✅ | N/A | +| `type` | [components.ORAnthropicBashToolResultTypeOpenrouterBashToolResult](../components/oranthropicbashtoolresulttypeopenrouterbashtoolresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/oranthropicbashtoolresultfile.mdx b/docs/components/oranthropicbashtoolresultfile.mdx index 350d2e761..78c476877 100644 --- a/docs/components/oranthropicbashtoolresultfile.mdx +++ b/docs/components/oranthropicbashtoolresultfile.mdx @@ -6,9 +6,9 @@ title: "ORAnthropicBashToolResultFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | :heavy_check_mark: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ORAnthropicBashToolResultTypeContainerFileCitation](../components/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *str* | ✅ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `file_id` | *str* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `type` | [components.ORAnthropicBashToolResultTypeContainerFileCitation](../components/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/oranthropicservertooluseblock.mdx b/docs/components/oranthropicservertooluseblock.mdx index f88678aca..8cdfffcc2 100644 --- a/docs/components/oranthropicservertooluseblock.mdx +++ b/docs/components/oranthropicservertooluseblock.mdx @@ -6,8 +6,8 @@ title: "ORAnthropicServerToolUseBlock" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `caller` | [OptionalNullable[components.ORAnthropicNullableCaller]](../components/oranthropicnullablecaller.mdx) | :heavy_minus_sign: | N/A | \{
"type": "direct"
} | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `input` | *Optional[Any]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.ORAnthropicServerToolUseBlockType](../components/oranthropicservertooluseblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `caller` | [OptionalNullable[components.ORAnthropicNullableCaller]](../components/oranthropicnullablecaller.mdx) | ➖ | N/A | \{
"type": "direct"
} | +| `id` | *str* | ✅ | N/A | | +| `input` | *Optional[Any]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `type` | [components.ORAnthropicServerToolUseBlockType](../components/oranthropicservertooluseblocktype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/oranthropicshelltoolresult.mdx b/docs/components/oranthropicshelltoolresult.mdx index 4ac936c44..b9d19c835 100644 --- a/docs/components/oranthropicshelltoolresult.mdx +++ b/docs/components/oranthropicshelltoolresult.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:shell` call executed in the OpenRouter sandbox | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *Optional[str]* | :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` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `files` | List[[components.ORAnthropicShellToolResultFile](../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. | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ORAnthropicShellToolResultTypeOpenrouterShellToolResult](../components/oranthropicshelltoolresulttypeopenroutershelltoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *Optional[str]* | ➖ | 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` | Dict[str, *Any*] | ✅ | N/A | +| `files` | List[[components.ORAnthropicShellToolResultFile](../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. | +| `tool_use_id` | *str* | ✅ | N/A | +| `type` | [components.ORAnthropicShellToolResultTypeOpenrouterShellToolResult](../components/oranthropicshelltoolresulttypeopenroutershelltoolresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/oranthropicshelltoolresultfile.mdx b/docs/components/oranthropicshelltoolresultfile.mdx index 8ffa1419e..5784ab73e 100644 --- a/docs/components/oranthropicshelltoolresultfile.mdx +++ b/docs/components/oranthropicshelltoolresultfile.mdx @@ -6,9 +6,9 @@ title: "ORAnthropicShellToolResultFile" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | :heavy_check_mark: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ORAnthropicShellToolResultTypeContainerFileCitation](../components/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *str* | ✅ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `file_id` | *str* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `type` | [components.ORAnthropicShellToolResultTypeContainerFileCitation](../components/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/oranthropictoolsearchresult.mdx b/docs/components/oranthropictoolsearchresult.mdx index ba9b09a97..8b134c415 100644 --- a/docs/components/oranthropictoolsearchresult.mdx +++ b/docs/components/oranthropictoolsearchresult.mdx @@ -9,6 +9,6 @@ Router-owned deferred discovery result containing original selected tool definit | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `content` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ORAnthropicToolSearchResultType](../components/oranthropictoolsearchresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | Dict[str, *Any*] | ✅ | N/A | +| `tool_use_id` | *str* | ✅ | N/A | +| `type` | [components.ORAnthropicToolSearchResultType](../components/oranthropictoolsearchresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/oranthropictoolsearchresultparam.mdx b/docs/components/oranthropictoolsearchresultparam.mdx index 2bd24bad1..3a01b4006 100644 --- a/docs/components/oranthropictoolsearchresultparam.mdx +++ b/docs/components/oranthropictoolsearchresultparam.mdx @@ -9,6 +9,6 @@ Router-owned deferred discovery result for continuation. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `content` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ORAnthropicToolSearchResultParamType](../components/oranthropictoolsearchresultparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | Dict[str, *Any*] | ✅ | N/A | +| `tool_use_id` | *str* | ✅ | N/A | +| `type` | [components.ORAnthropicToolSearchResultParamType](../components/oranthropictoolsearchresultparamtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/organizationsettings.mdx b/docs/components/organizationsettings.mdx index 6a67a56e8..c8e3952d6 100644 --- a/docs/components/organizationsettings.mdx +++ b/docs/components/organizationsettings.mdx @@ -6,5 +6,5 @@ title: "OrganizationSettings" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | -| `is_filtered_model_catalog_enabled` | *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` | *str* | ✅ | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | +| `is_filtered_model_catalog_enabled` | *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/components/outcomeexit.mdx b/docs/components/outcomeexit.mdx index 56aaef49a..98046ccf3 100644 --- a/docs/components/outcomeexit.mdx +++ b/docs/components/outcomeexit.mdx @@ -6,6 +6,6 @@ title: "OutcomeExit" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `exit_code` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.TypeExit](../components/typeexit.mdx) | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `exit_code` | *int* | ✅ | N/A | +| `type` | [components.TypeExit](../components/typeexit.mdx) | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/outcometimeout.mdx b/docs/components/outcometimeout.mdx index 2dc6cbbbd..e093c9b5a 100644 --- a/docs/components/outcometimeout.mdx +++ b/docs/components/outcometimeout.mdx @@ -6,5 +6,5 @@ title: "OutcomeTimeout" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `type` | [components.TypeTimeout](../components/typetimeout.mdx) | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [components.TypeTimeout](../components/typetimeout.mdx) | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/outputadvisorservertoolitem.mdx b/docs/components/outputadvisorservertoolitem.mdx index 856695ef8..0ee933722 100644 --- a/docs/components/outputadvisorservertoolitem.mdx +++ b/docs/components/outputadvisorservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:advisor server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `advice` | *Optional[str]* | :heavy_minus_sign: | The advisor model's response (the advice text returned to the executor). | | -| `error` | *Optional[str]* | :heavy_minus_sign: | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `instance_name` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Slug of the advisor model that was consulted. | | -| `prompt` | *Optional[str]* | :heavy_minus_sign: | The prompt the executor sent to the advisor. | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputAdvisorServerToolItemType](../components/outputadvisorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `advice` | *Optional[str]* | ➖ | The advisor model's response (the advice text returned to the executor). | | +| `error` | *Optional[str]* | ➖ | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `instance_name` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Slug of the advisor model that was consulted. | | +| `prompt` | *Optional[str]* | ➖ | The prompt the executor sent to the advisor. | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputAdvisorServerToolItemType](../components/outputadvisorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputapplypatchcallitem.mdx b/docs/components/outputapplypatchcallitem.mdx index 2a02c6e3d..36691c60e 100644 --- a/docs/components/outputapplypatchcallitem.mdx +++ b/docs/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 | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `operation` | [components.ApplyPatchCallOperation](../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](../components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | [components.OutputApplyPatchCallItemType](../components/outputapplypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `operation` | [components.ApplyPatchCallOperation](../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](../components/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | +| `type` | [components.OutputApplyPatchCallItemType](../components/outputapplypatchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputapplypatchservertoolitem.mdx b/docs/components/outputapplypatchservertoolitem.mdx index d8e965bb7..2a6f09950 100644 --- a/docs/components/outputapplypatchservertoolitem.mdx +++ b/docs/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 | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `operation` | [Optional[components.ApplyPatchCallOperation]](../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](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputApplyPatchServerToolItemType](../components/outputapplypatchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `call_id` | *Optional[str]* | ➖ | N/A | | +| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | +| `operation` | [Optional[components.ApplyPatchCallOperation]](../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](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputApplyPatchServerToolItemType](../components/outputapplypatchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputarmorblockeditem.mdx b/docs/components/outputarmorblockeditem.mdx index b1d7b64cd..a36c56713 100644 --- a/docs/components/outputarmorblockeditem.mdx +++ b/docs/components/outputarmorblockeditem.mdx @@ -9,12 +9,12 @@ A client tool call that OpenRouter Armor blocked. Emitted in place of the call w | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | The arguments exactly as the model wrote them. | -| `call_id` | *str* | :heavy_check_mark: | The call id the model chose. Use it to find this call in `safeguard_results`. | -| `explanation` | *str* | :heavy_check_mark: | The rule that blocked the call, in the same `[Rule Name]` form as `safeguard_results`. | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | The name of the tool the model called. | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | The namespace the tool belongs to, for namespaced tools such as MCP. Absent for a plain function tool. | -| `reason` | *str* | :heavy_check_mark: | The error text the model received as the result of this call. Sending this item back replays that text to the model. | -| `status` | [components.OutputArmorBlockedItemStatus](../components/outputarmorblockeditemstatus.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.OutputArmorBlockedItemType](../components/outputarmorblockeditemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *str* | ✅ | The arguments exactly as the model wrote them. | +| `call_id` | *str* | ✅ | The call id the model chose. Use it to find this call in `safeguard_results`. | +| `explanation` | *str* | ✅ | The rule that blocked the call, in the same `[Rule Name]` form as `safeguard_results`. | +| `id` | *str* | ✅ | N/A | +| `name` | *str* | ✅ | The name of the tool the model called. | +| `namespace` | *Optional[str]* | ➖ | The namespace the tool belongs to, for namespaced tools such as MCP. Absent for a plain function tool. | +| `reason` | *str* | ✅ | The error text the model received as the result of this call. Sending this item back replays that text to the model. | +| `status` | [components.OutputArmorBlockedItemStatus](../components/outputarmorblockeditemstatus.mdx) | ✅ | N/A | +| `type` | [components.OutputArmorBlockedItemType](../components/outputarmorblockeditemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputbashservertoolitem.mdx b/docs/components/outputbashservertoolitem.mdx index 30a101b0a..e2290a047 100644 --- a/docs/components/outputbashservertoolitem.mdx +++ b/docs/components/outputbashservertoolitem.mdx @@ -9,15 +9,15 @@ An openrouter:bash server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *OptionalNullable[str]* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | -| `call_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | -| `command` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `container_id` | *Optional[str]* | :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` | *Optional[str]* | :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. | | -| `exit_code` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `files` | List[[components.OutputBashServerToolItemFile](../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `stderr` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `stdout` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputBashServerToolItemTypeOpenrouterBash](../components/outputbashservertoolitemtypeopenrouterbash.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *OptionalNullable[str]* | ➖ | The raw tool-call arguments string as emitted by the model. | | +| `call_id` | *OptionalNullable[str]* | ➖ | The model-generated tool call id from the originating turn. | | +| `command` | *Optional[str]* | ➖ | N/A | | +| `container_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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. | | +| `exit_code` | *Optional[int]* | ➖ | N/A | | +| `files` | List[[components.OutputBashServerToolItemFile](../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` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `stderr` | *Optional[str]* | ➖ | N/A | | +| `stdout` | *Optional[str]* | ➖ | N/A | | +| `type` | [components.OutputBashServerToolItemTypeOpenrouterBash](../components/outputbashservertoolitemtypeopenrouterbash.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputbashservertoolitemfile.mdx b/docs/components/outputbashservertoolitemfile.mdx index 9e4f74c6c..14b756bdc 100644 --- a/docs/components/outputbashservertoolitemfile.mdx +++ b/docs/components/outputbashservertoolitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputBashServerToolItemFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | :heavy_check_mark: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.OutputBashServerToolItemTypeContainerFileCitation](../components/outputbashservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *str* | ✅ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `file_id` | *str* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `type` | [components.OutputBashServerToolItemTypeContainerFileCitation](../components/outputbashservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputbrowseruseservertoolitem.mdx b/docs/components/outputbrowseruseservertoolitem.mdx index d8f75dc43..b2ced565f 100644 --- a/docs/components/outputbrowseruseservertoolitem.mdx +++ b/docs/components/outputbrowseruseservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:browser_use server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `action` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `screenshot_b64` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputBrowserUseServerToolItemType](../components/outputbrowseruseservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | *Optional[str]* | ➖ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `screenshot_b64` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputBrowserUseServerToolItemType](../components/outputbrowseruseservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputcodeinterpretercallitem.mdx b/docs/components/outputcodeinterpretercallitem.mdx index 2998f9693..174dee5c3 100644 --- a/docs/components/outputcodeinterpretercallitem.mdx +++ b/docs/components/outputcodeinterpretercallitem.mdx @@ -9,10 +9,10 @@ A code interpreter execution call with outputs | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `container_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `outputs` | List[[components.OutputCodeInterpreterCallItemOutput](../components/outputcodeinterpretercallitemoutput.mdx)] | :heavy_minus_sign: | N/A | | -| `status` | [components.OutputCodeInterpreterCallItemStatus](../components/outputcodeinterpretercallitemstatus.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.OutputCodeInterpreterCallItemType](../components/outputcodeinterpretercallitemtype.mdx) | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *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[str]* | ➖ | N/A | | +| `container_id` | *Optional[str]* | ➖ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `outputs` | List[[components.OutputCodeInterpreterCallItemOutput](../components/outputcodeinterpretercallitemoutput.mdx)] | ➖ | N/A | | +| `status` | [components.OutputCodeInterpreterCallItemStatus](../components/outputcodeinterpretercallitemstatus.mdx) | ✅ | N/A | | +| `type` | [components.OutputCodeInterpreterCallItemType](../components/outputcodeinterpretercallitemtype.mdx) | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/outputcodeinterpreterservertoolitem.mdx b/docs/components/outputcodeinterpreterservertoolitem.mdx index 3b97b10ff..912fac3ed 100644 --- a/docs/components/outputcodeinterpreterservertoolitem.mdx +++ b/docs/components/outputcodeinterpreterservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:code_interpreter server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `code` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `exit_code` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `language` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `stderr` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `stdout` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputCodeInterpreterServerToolItemType](../components/outputcodeinterpreterservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `code` | *Optional[str]* | ➖ | N/A | | +| `exit_code` | *Optional[int]* | ➖ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `language` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `stderr` | *Optional[str]* | ➖ | N/A | | +| `stdout` | *Optional[str]* | ➖ | N/A | | +| `type` | [components.OutputCodeInterpreterServerToolItemType](../components/outputcodeinterpreterservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputcomputercallitem.mdx b/docs/components/outputcomputercallitem.mdx index f765c59f3..80f347e66 100644 --- a/docs/components/outputcomputercallitem.mdx +++ b/docs/components/outputcomputercallitem.mdx @@ -6,9 +6,9 @@ title: "OutputComputerCallItem" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `action` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `pending_safety_checks` | List[[components.PendingSafetyCheck](../components/pendingsafetycheck.mdx)] | :heavy_check_mark: | N/A | -| `status` | [components.OutputComputerCallItemStatus](../components/outputcomputercallitemstatus.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.OutputComputerCallItemType](../components/outputcomputercallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `action` | *Optional[Any]* | ➖ | N/A | +| `call_id` | *str* | ✅ | N/A | +| `id` | *Optional[str]* | ➖ | N/A | +| `pending_safety_checks` | List[[components.PendingSafetyCheck](../components/pendingsafetycheck.mdx)] | ✅ | N/A | +| `status` | [components.OutputComputerCallItemStatus](../components/outputcomputercallitemstatus.mdx) | ✅ | N/A | +| `type` | [components.OutputComputerCallItemType](../components/outputcomputercallitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputcustomtoolcallitem.mdx b/docs/components/outputcustomtoolcallitem.mdx index a9d4295dc..ab9194912 100644 --- a/docs/components/outputcustomtoolcallitem.mdx +++ b/docs/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_` | *Optional[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 | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `input` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.OutputCustomToolCallItemStatus]](../components/outputcustomtoolcallitemstatus.mdx) | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputCustomToolCallItemType](../components/outputcustomtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async_` | *Optional[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 | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `input` | *str* | ✅ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.OutputCustomToolCallItemStatus]](../components/outputcustomtoolcallitemstatus.mdx) | ➖ | N/A | | +| `type` | [components.OutputCustomToolCallItemType](../components/outputcustomtoolcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputdatetimeitem.mdx b/docs/components/outputdatetimeitem.mdx index a3abcac18..eb8558d45 100644 --- a/docs/components/outputdatetimeitem.mdx +++ b/docs/components/outputdatetimeitem.mdx @@ -9,9 +9,9 @@ An openrouter:datetime server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `datetime_` | *str* | :heavy_check_mark: | ISO 8601 datetime string | | -| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `timezone` | *str* | :heavy_check_mark: | IANA timezone name | | -| `type` | [components.OutputDatetimeItemType](../components/outputdatetimeitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `datetime_` | *str* | ✅ | ISO 8601 datetime string | | +| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `timezone` | *str* | ✅ | IANA timezone name | | +| `type` | [components.OutputDatetimeItemType](../components/outputdatetimeitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputfilesearchcallitem.mdx b/docs/components/outputfilesearchcallitem.mdx index 9b9ef4445..c8463cc8a 100644 --- a/docs/components/outputfilesearchcallitem.mdx +++ b/docs/components/outputfilesearchcallitem.mdx @@ -6,7 +6,7 @@ title: "OutputFileSearchCallItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `queries` | List[*str*] | :heavy_check_mark: | N/A | | -| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputFileSearchCallItemType](../components/outputfilesearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *str* | ✅ | N/A | | +| `queries` | List[*str*] | ✅ | N/A | | +| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputFileSearchCallItemType](../components/outputfilesearchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputfilesearchservertoolitem.mdx b/docs/components/outputfilesearchservertoolitem.mdx index 2095688ca..38a9f0790 100644 --- a/docs/components/outputfilesearchservertoolitem.mdx +++ b/docs/components/outputfilesearchservertoolitem.mdx @@ -9,7 +9,7 @@ An openrouter:file_search server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `queries` | List[*str*] | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputFileSearchServerToolItemType](../components/outputfilesearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *Optional[str]* | ➖ | N/A | | +| `queries` | List[*str*] | ➖ | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputFileSearchServerToolItemType](../components/outputfilesearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputfilesservertoolitem.mdx b/docs/components/outputfilesservertoolitem.mdx index f4514c8f3..6a52f38e3 100644 --- a/docs/components/outputfilesservertoolitem.mdx +++ b/docs/components/outputfilesservertoolitem.mdx @@ -9,13 +9,13 @@ An openrouter:files server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `arguments` | *OptionalNullable[str]* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | -| `call_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | -| `error` | *Optional[str]* | :heavy_minus_sign: | Error message when the file operation failed. | | -| `file_id` | *Optional[str]* | :heavy_minus_sign: | The target file id supplied in the tool-call arguments. | | -| `filename` | *Optional[str]* | :heavy_minus_sign: | The target filename supplied in the tool-call arguments. | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `operation` | *Optional[str]* | :heavy_minus_sign: | The file operation performed (list, read, write, or edit). | | -| `result` | *Optional[str]* | :heavy_minus_sign: | JSON-serialized result of the file operation. | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputFilesServerToolItemType](../components/outputfilesservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *OptionalNullable[str]* | ➖ | The raw tool-call arguments string as emitted by the model. | | +| `call_id` | *OptionalNullable[str]* | ➖ | The model-generated tool call id from the originating turn. | | +| `error` | *Optional[str]* | ➖ | Error message when the file operation failed. | | +| `file_id` | *Optional[str]* | ➖ | The target file id supplied in the tool-call arguments. | | +| `filename` | *Optional[str]* | ➖ | The target filename supplied in the tool-call arguments. | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `operation` | *Optional[str]* | ➖ | The file operation performed (list, read, write, or edit). | | +| `result` | *Optional[str]* | ➖ | JSON-serialized result of the file operation. | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputFilesServerToolItemType](../components/outputfilesservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputfunctioncallitem.mdx b/docs/components/outputfunctioncallitem.mdx index d66767cb2..e3c90cdb2 100644 --- a/docs/components/outputfunctioncallitem.mdx +++ b/docs/components/outputfunctioncallitem.mdx @@ -6,13 +6,13 @@ title: "OutputFunctionCallItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | N/A | | -| `async_` | *Optional[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 | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.OutputFunctionCallItemStatusUnion]](../components/outputfunctioncallitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputFunctionCallItemType](../components/outputfunctioncallitemtype.mdx) | :heavy_check_mark: | N/A | | -| `subagent_id` | *Optional[str]* | :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. | | -| `subagent_items` | List[[components.OutputFunctionCallItemSubagentItem](../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` | *str* | ✅ | N/A | | +| `async_` | *Optional[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 | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.OutputFunctionCallItemStatusUnion]](../components/outputfunctioncallitemstatusunion.mdx) | ➖ | N/A | | +| `type` | [components.OutputFunctionCallItemType](../components/outputfunctioncallitemtype.mdx) | ✅ | N/A | | +| `subagent_id` | *Optional[str]* | ➖ | 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. | | +| `subagent_items` | List[[components.OutputFunctionCallItemSubagentItem](../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/components/outputfunctioncallitemsubagentitem.mdx b/docs/components/outputfunctioncallitemsubagentitem.mdx index 7cab07dcf..d1a5eda8f 100644 --- a/docs/components/outputfunctioncallitemsubagentitem.mdx +++ b/docs/components/outputfunctioncallitemsubagentitem.mdx @@ -6,5 +6,5 @@ title: "OutputFunctionCallItemSubagentItem" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *str* | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/outputfusionservertoolitem.mdx b/docs/components/outputfusionservertoolitem.mdx index 90a048bd9..1d531f3d8 100644 --- a/docs/components/outputfusionservertoolitem.mdx +++ b/docs/components/outputfusionservertoolitem.mdx @@ -9,12 +9,12 @@ An openrouter:fusion server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis` | [Optional[components.FusionAnalysisResult]](../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` | *Optional[str]* | :heavy_minus_sign: | Error message when the fusion run did not produce an analysis result. | | -| `failed_models` | List[[components.FailedModel](../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. | | -| `failure_reason` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `responses` | List[[components.OutputFusionServerToolItemResponse](../components/outputfusionservertoolitemresponse.mdx)] | :heavy_minus_sign: | Analysis models that produced a response in this fusion run, with each model's full panel content. | | -| `sources` | List[[components.FusionSource](../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](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputFusionServerToolItemType](../components/outputfusionservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `analysis` | [Optional[components.FusionAnalysisResult]](../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` | *Optional[str]* | ➖ | Error message when the fusion run did not produce an analysis result. | | +| `failed_models` | List[[components.FailedModel](../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. | | +| `failure_reason` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | +| `responses` | List[[components.OutputFusionServerToolItemResponse](../components/outputfusionservertoolitemresponse.mdx)] | ➖ | Analysis models that produced a response in this fusion run, with each model's full panel content. | | +| `sources` | List[[components.FusionSource](../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](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputFusionServerToolItemType](../components/outputfusionservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputfusionservertoolitemresponse.mdx b/docs/components/outputfusionservertoolitemresponse.mdx index f7862f7dc..a3b2ea073 100644 --- a/docs/components/outputfusionservertoolitemresponse.mdx +++ b/docs/components/outputfusionservertoolitemresponse.mdx @@ -6,5 +6,5 @@ title: "OutputFusionServerToolItemResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *Optional[str]* | ➖ | N/A | +| `model` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputimagegenerationcallitem.mdx b/docs/components/outputimagegenerationcallitem.mdx index f0148fb51..9f7a56ac9 100644 --- a/docs/components/outputimagegenerationcallitem.mdx +++ b/docs/components/outputimagegenerationcallitem.mdx @@ -6,8 +6,8 @@ title: "OutputImageGenerationCallItem" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ImageGenerationStatus](../components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputImageGenerationCallItemType](../components/outputimagegenerationcallitemtype.mdx) | :heavy_check_mark: | N/A | | -| `prompt` | *Optional[str]* | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file +| `id` | *str* | ✅ | N/A | | +| `result` | *OptionalNullable[str]* | ➖ | N/A | | +| `status` | [components.ImageGenerationStatus](../components/imagegenerationstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputImageGenerationCallItemType](../components/outputimagegenerationcallitemtype.mdx) | ✅ | N/A | | +| `prompt` | *Optional[str]* | ➖ | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file diff --git a/docs/components/outputimagegenerationservertoolitem.mdx b/docs/components/outputimagegenerationservertoolitem.mdx index 4b522ce89..a3dd0aeca 100644 --- a/docs/components/outputimagegenerationservertoolitem.mdx +++ b/docs/components/outputimagegenerationservertoolitem.mdx @@ -9,12 +9,12 @@ An openrouter:image_generation server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `image_b64` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `prompt` | *Optional[str]* | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | -| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | -| `revised_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputImageGenerationServerToolItemType](../components/outputimagegenerationservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | +| `image_b64` | *Optional[str]* | ➖ | N/A | | +| `image_url` | *Optional[str]* | ➖ | N/A | | +| `prompt` | *Optional[str]* | ➖ | The prompt (possibly rewritten) that the image was generated from. | | +| `result` | *OptionalNullable[str]* | ➖ | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | +| `revised_prompt` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputImageGenerationServerToolItemType](../components/outputimagegenerationservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemapplypatchcall.mdx b/docs/components/outputitemapplypatchcall.mdx index a86389811..789dc5e80 100644 --- a/docs/components/outputitemapplypatchcall.mdx +++ b/docs/components/outputitemapplypatchcall.mdx @@ -6,9 +6,9 @@ title: "OutputItemApplyPatchCall" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `created_by` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `operation` | [components.Operation](../components/operation.mdx) | :heavy_check_mark: | N/A | -| `status` | [components.OutputItemApplyPatchCallStatus](../components/outputitemapplypatchcallstatus.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.OutputItemApplyPatchCallType](../components/outputitemapplypatchcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | +| `created_by` | *Optional[str]* | ➖ | N/A | +| `id` | *str* | ✅ | N/A | +| `operation` | [components.Operation](../components/operation.mdx) | ✅ | N/A | +| `status` | [components.OutputItemApplyPatchCallStatus](../components/outputitemapplypatchcallstatus.mdx) | ✅ | N/A | +| `type` | [components.OutputItemApplyPatchCallType](../components/outputitemapplypatchcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputitemcodeinterpretercall.mdx b/docs/components/outputitemcodeinterpretercall.mdx index da739c3a2..b66d181aa 100644 --- a/docs/components/outputitemcodeinterpretercall.mdx +++ b/docs/components/outputitemcodeinterpretercall.mdx @@ -6,10 +6,10 @@ title: "OutputItemCodeInterpreterCall" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `container_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `outputs` | List[[components.OutputItemCodeInterpreterCallOutput](../components/outputitemcodeinterpretercalloutput.mdx)] | :heavy_minus_sign: | N/A | | -| `status` | [components.OutputItemCodeInterpreterCallStatus](../components/outputitemcodeinterpretercallstatus.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.OutputItemCodeInterpreterCallType](../components/outputitemcodeinterpretercalltype.mdx) | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *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[str]* | ➖ | N/A | | +| `container_id` | *Optional[str]* | ➖ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `outputs` | List[[components.OutputItemCodeInterpreterCallOutput](../components/outputitemcodeinterpretercalloutput.mdx)] | ➖ | N/A | | +| `status` | [components.OutputItemCodeInterpreterCallStatus](../components/outputitemcodeinterpretercallstatus.mdx) | ✅ | N/A | | +| `type` | [components.OutputItemCodeInterpreterCallType](../components/outputitemcodeinterpretercalltype.mdx) | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/outputitemcustomtoolcall.mdx b/docs/components/outputitemcustomtoolcall.mdx index 1bc0ba739..f45cc3cc6 100644 --- a/docs/components/outputitemcustomtoolcall.mdx +++ b/docs/components/outputitemcustomtoolcall.mdx @@ -6,11 +6,11 @@ title: "OutputItemCustomToolCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `async_` | *Optional[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 | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `input` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.OutputItemCustomToolCallStatus]](../components/outputitemcustomtoolcallstatus.mdx) | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputItemCustomToolCallType](../components/outputitemcustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async_` | *Optional[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 | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `input` | *str* | ✅ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.OutputItemCustomToolCallStatus]](../components/outputitemcustomtoolcallstatus.mdx) | ➖ | N/A | | +| `type` | [components.OutputItemCustomToolCallType](../components/outputitemcustomtoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemfilesearchcall.mdx b/docs/components/outputitemfilesearchcall.mdx index 5e9497c99..4dc8873d9 100644 --- a/docs/components/outputitemfilesearchcall.mdx +++ b/docs/components/outputitemfilesearchcall.mdx @@ -6,7 +6,7 @@ title: "OutputItemFileSearchCall" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `queries` | List[*str*] | :heavy_check_mark: | N/A | | -| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputItemFileSearchCallType](../components/outputitemfilesearchcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *str* | ✅ | N/A | | +| `queries` | List[*str*] | ✅ | N/A | | +| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputItemFileSearchCallType](../components/outputitemfilesearchcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemfunctioncall.mdx b/docs/components/outputitemfunctioncall.mdx index d556439da..f835dedd6 100644 --- a/docs/components/outputitemfunctioncall.mdx +++ b/docs/components/outputitemfunctioncall.mdx @@ -6,11 +6,11 @@ title: "OutputItemFunctionCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `arguments` | *str* | :heavy_check_mark: | N/A | | -| `async_` | *Optional[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 | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.OutputItemFunctionCallStatusUnion]](../components/outputitemfunctioncallstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputItemFunctionCallType](../components/outputitemfunctioncalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | | +| `async_` | *Optional[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 | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `namespace` | *Optional[str]* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [Optional[components.OutputItemFunctionCallStatusUnion]](../components/outputitemfunctioncallstatusunion.mdx) | ➖ | N/A | | +| `type` | [components.OutputItemFunctionCallType](../components/outputitemfunctioncalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemimagegenerationcall.mdx b/docs/components/outputitemimagegenerationcall.mdx index a9c86ddb3..3725ec33e 100644 --- a/docs/components/outputitemimagegenerationcall.mdx +++ b/docs/components/outputitemimagegenerationcall.mdx @@ -6,7 +6,7 @@ title: "OutputItemImageGenerationCall" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ImageGenerationStatus](../components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputItemImageGenerationCallType](../components/outputitemimagegenerationcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *str* | ✅ | N/A | | +| `result` | *OptionalNullable[str]* | ➖ | N/A | | +| `status` | [components.ImageGenerationStatus](../components/imagegenerationstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputItemImageGenerationCallType](../components/outputitemimagegenerationcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputitemreasoning.mdx b/docs/components/outputitemreasoning.mdx index 1ea9da000..218ed176d 100644 --- a/docs/components/outputitemreasoning.mdx +++ b/docs/components/outputitemreasoning.mdx @@ -6,9 +6,9 @@ title: "OutputItemReasoning" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `status` | [Optional[components.OutputItemReasoningStatusUnion]](../components/outputitemreasoningstatusunion.mdx) | :heavy_minus_sign: | N/A | -| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | :heavy_check_mark: | N/A | -| `type` | [components.OutputItemReasoningType](../components/outputitemreasoningtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | ➖ | N/A | +| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | +| `id` | *str* | ✅ | N/A | +| `status` | [Optional[components.OutputItemReasoningStatusUnion]](../components/outputitemreasoningstatusunion.mdx) | ➖ | N/A | +| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | ✅ | N/A | +| `type` | [components.OutputItemReasoningType](../components/outputitemreasoningtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputitemwebsearchcall.mdx b/docs/components/outputitemwebsearchcall.mdx index 9ff87e42a..cc322612b 100644 --- a/docs/components/outputitemwebsearchcall.mdx +++ b/docs/components/outputitemwebsearchcall.mdx @@ -6,8 +6,8 @@ title: "OutputItemWebSearchCall" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [Optional[components.OutputItemWebSearchCallActionUnion]](../components/outputitemwebsearchcallactionunion.mdx) | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputItemWebSearchCallTypeWebSearchCall](../components/outputitemwebsearchcalltypewebsearchcall.mdx) | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *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` | [Optional[components.OutputItemWebSearchCallActionUnion]](../components/outputitemwebsearchcallactionunion.mdx) | ➖ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputItemWebSearchCallTypeWebSearchCall](../components/outputitemwebsearchcalltypewebsearchcall.mdx) | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/outputitemwebsearchcallactionfindinpage.mdx b/docs/components/outputitemwebsearchcallactionfindinpage.mdx index 4799afedd..814cdb44b 100644 --- a/docs/components/outputitemwebsearchcallactionfindinpage.mdx +++ b/docs/components/outputitemwebsearchcallactionfindinpage.mdx @@ -6,6 +6,6 @@ title: "OutputItemWebSearchCallActionFindInPage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `pattern` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.OutputItemWebSearchCallTypeFindInPage](../components/outputitemwebsearchcalltypefindinpage.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `pattern` | *str* | ✅ | N/A | +| `type` | [components.OutputItemWebSearchCallTypeFindInPage](../components/outputitemwebsearchcalltypefindinpage.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputitemwebsearchcallactionopenpage.mdx b/docs/components/outputitemwebsearchcallactionopenpage.mdx index 12b280f5d..c4219877e 100644 --- a/docs/components/outputitemwebsearchcallactionopenpage.mdx +++ b/docs/components/outputitemwebsearchcallactionopenpage.mdx @@ -6,5 +6,5 @@ title: "OutputItemWebSearchCallActionOpenPage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `type` | [components.OutputItemWebSearchCallTypeOpenPage](../components/outputitemwebsearchcalltypeopenpage.mdx) | :heavy_check_mark: | N/A | -| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [components.OutputItemWebSearchCallTypeOpenPage](../components/outputitemwebsearchcalltypeopenpage.mdx) | ✅ | N/A | +| `url` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/outputitemwebsearchcallactionsearch.mdx b/docs/components/outputitemwebsearchcallactionsearch.mdx index c747e378a..12f6d4a14 100644 --- a/docs/components/outputitemwebsearchcallactionsearch.mdx +++ b/docs/components/outputitemwebsearchcallactionsearch.mdx @@ -6,7 +6,7 @@ title: "OutputItemWebSearchCallActionSearch" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `queries` | List[*str*] | :heavy_minus_sign: | N/A | -| `query` | *str* | :heavy_check_mark: | N/A | -| `sources` | List[[components.WebSearchSource](../components/websearchsource.mdx)] | :heavy_minus_sign: | N/A | -| `type` | [components.OutputItemWebSearchCallTypeSearch](../components/outputitemwebsearchcalltypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `queries` | List[*str*] | ➖ | N/A | +| `query` | *str* | ✅ | N/A | +| `sources` | List[[components.WebSearchSource](../components/websearchsource.mdx)] | ➖ | N/A | +| `type` | [components.OutputItemWebSearchCallTypeSearch](../components/outputitemwebsearchcalltypesearch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputmcpservertoolitem.mdx b/docs/components/outputmcpservertoolitem.mdx index d11d1e776..0765d532b 100644 --- a/docs/components/outputmcpservertoolitem.mdx +++ b/docs/components/outputmcpservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:mcp server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `server_label` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `tool_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputMcpServerToolItemType](../components/outputmcpservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *Optional[str]* | ➖ | N/A | | +| `server_label` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `tool_name` | *Optional[str]* | ➖ | N/A | | +| `type` | [components.OutputMcpServerToolItemType](../components/outputmcpservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputmemoryservertoolitem.mdx b/docs/components/outputmemoryservertoolitem.mdx index 57345928f..b44e3d109 100644 --- a/docs/components/outputmemoryservertoolitem.mdx +++ b/docs/components/outputmemoryservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:memory server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `action` | [Optional[components.ActionEnum]](../components/actionenum.mdx) | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputMemoryServerToolItemType](../components/outputmemoryservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | -| `value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `action` | [Optional[components.ActionEnum]](../components/actionenum.mdx) | ➖ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `key` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputMemoryServerToolItemType](../components/outputmemoryservertoolitemtype.mdx) | ✅ | N/A | | +| `value` | *Optional[Any]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/outputmessage.mdx b/docs/components/outputmessage.mdx index 9cd8a403f..7020a531d 100644 --- a/docs/components/outputmessage.mdx +++ b/docs/components/outputmessage.mdx @@ -6,9 +6,9 @@ title: "OutputMessage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.OutputMessageContent](../components/outputmessagecontent.mdx)] | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `phase` | [OptionalNullable[components.OutputMessagePhaseUnion]](../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](../components/outputmessagerole.mdx) | :heavy_check_mark: | N/A | -| `status` | [Optional[components.OutputMessageStatusUnion]](../components/outputmessagestatusunion.mdx) | :heavy_minus_sign: | N/A | -| `type` | [components.OutputMessageType](../components/outputmessagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | List[[components.OutputMessageContent](../components/outputmessagecontent.mdx)] | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `phase` | [OptionalNullable[components.OutputMessagePhaseUnion]](../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](../components/outputmessagerole.mdx) | ✅ | N/A | +| `status` | [Optional[components.OutputMessageStatusUnion]](../components/outputmessagestatusunion.mdx) | ➖ | N/A | +| `type` | [components.OutputMessageType](../components/outputmessagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputmessageitem.mdx b/docs/components/outputmessageitem.mdx index f02e8d23c..b8d199b6f 100644 --- a/docs/components/outputmessageitem.mdx +++ b/docs/components/outputmessageitem.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.OutputMessageItemContent](../components/outputmessageitemcontent.mdx)] | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `phase` | [OptionalNullable[components.OutputMessageItemPhaseUnion]](../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](../components/outputmessageitemrole.mdx) | :heavy_check_mark: | N/A | -| `status` | [Optional[components.OutputMessageItemStatusUnion]](../components/outputmessageitemstatusunion.mdx) | :heavy_minus_sign: | N/A | -| `type` | [components.OutputMessageItemType](../components/outputmessageitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | List[[components.OutputMessageItemContent](../components/outputmessageitemcontent.mdx)] | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `phase` | [OptionalNullable[components.OutputMessageItemPhaseUnion]](../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](../components/outputmessageitemrole.mdx) | ✅ | N/A | +| `status` | [Optional[components.OutputMessageItemStatusUnion]](../components/outputmessageitemstatusunion.mdx) | ➖ | N/A | +| `type` | [components.OutputMessageItemType](../components/outputmessageitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputreasoningitem.mdx b/docs/components/outputreasoningitem.mdx index 761085bfa..e150ddac8 100644 --- a/docs/components/outputreasoningitem.mdx +++ b/docs/components/outputreasoningitem.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [Optional[components.OutputReasoningItemStatusUnion]](../components/outputreasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | :heavy_check_mark: | N/A | | -| `type` | [components.OutputReasoningItemType](../components/outputreasoningitemtype.mdx) | :heavy_check_mark: | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | ➖ | N/A | | +| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `status` | [Optional[components.OutputReasoningItemStatusUnion]](../components/outputreasoningitemstatusunion.mdx) | ➖ | N/A | | +| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | ✅ | N/A | | +| `type` | [components.OutputReasoningItemType](../components/outputreasoningitemtype.mdx) | ✅ | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | +| `signature` | *OptionalNullable[str]* | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/components/outputsearchmodelsservertoolitem.mdx b/docs/components/outputsearchmodelsservertoolitem.mdx index 0ee05cf72..07583af41 100644 --- a/docs/components/outputsearchmodelsservertoolitem.mdx +++ b/docs/components/outputsearchmodelsservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:experimental__search_models server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *Optional[str]* | :heavy_minus_sign: | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | -| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputSearchModelsServerToolItemType](../components/outputsearchmodelsservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *Optional[str]* | ➖ | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | +| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | +| `query` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputSearchModelsServerToolItemType](../components/outputsearchmodelsservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputshellcallitem.mdx b/docs/components/outputshellcallitem.mdx index 6c6d71643..a340e0b89 100644 --- a/docs/components/outputshellcallitem.mdx +++ b/docs/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` | [Optional[components.OutputShellCallItemAction]](../components/outputshellcallitemaction.mdx) | :heavy_minus_sign: | N/A | | -| `arguments` | *OptionalNullable[str]* | :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. | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.ShellCallStatus](../components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | -| `type` | [components.OutputShellCallItemType](../components/outputshellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [Optional[components.OutputShellCallItemAction]](../components/outputshellcallitemaction.mdx) | ➖ | N/A | | +| `arguments` | *OptionalNullable[str]* | ➖ | 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. | | +| `call_id` | *str* | ✅ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `status` | [components.ShellCallStatus](../components/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | +| `type` | [components.OutputShellCallItemType](../components/outputshellcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputshellcallitemaction.mdx b/docs/components/outputshellcallitemaction.mdx index 2e9c76f3d..b225a6206 100644 --- a/docs/components/outputshellcallitemaction.mdx +++ b/docs/components/outputshellcallitemaction.mdx @@ -6,6 +6,6 @@ title: "OutputShellCallItemAction" | Field | Type | Required | Description | | ------------------- | ------------------- | ------------------- | ------------------- | -| `commands` | List[*str*] | :heavy_check_mark: | N/A | -| `max_output_length` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `timeout_ms` | *Nullable[int]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `commands` | List[*str*] | ✅ | N/A | +| `max_output_length` | *Nullable[int]* | ✅ | N/A | +| `timeout_ms` | *Nullable[int]* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputshellcalloutputitem.mdx b/docs/components/outputshellcalloutputitem.mdx index eb07476e3..42388960f 100644 --- a/docs/components/outputshellcalloutputitem.mdx +++ b/docs/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 | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `container_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | List[[components.OutputShellCallOutputItemFile](../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` | *str* | :heavy_check_mark: | N/A | | -| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | :heavy_check_mark: | N/A | | -| `status` | [components.ShellCallStatus](../components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | -| `type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../components/outputshellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | | +| `container_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | List[[components.OutputShellCallOutputItemFile](../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` | *str* | ✅ | N/A | | +| `max_output_length` | *OptionalNullable[int]* | ➖ | N/A | | +| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | ✅ | N/A | | +| `status` | [components.ShellCallStatus](../components/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | +| `type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../components/outputshellcalloutputitemtypeshellcalloutput.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputshellcalloutputitemfile.mdx b/docs/components/outputshellcalloutputitemfile.mdx index 5abec4933..b289b18b4 100644 --- a/docs/components/outputshellcalloutputitemfile.mdx +++ b/docs/components/outputshellcalloutputitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputShellCallOutputItemFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | :heavy_check_mark: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.OutputShellCallOutputItemTypeContainerFileCitation](../components/outputshellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *str* | ✅ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `file_id` | *str* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `type` | [components.OutputShellCallOutputItemTypeContainerFileCitation](../components/outputshellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputshellservertoolitem.mdx b/docs/components/outputshellservertoolitem.mdx index 0f0bbc33c..6c601392f 100644 --- a/docs/components/outputshellservertoolitem.mdx +++ b/docs/components/outputshellservertoolitem.mdx @@ -9,13 +9,13 @@ An openrouter:shell server tool output item | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [Optional[components.OutputShellServerToolItemAction]](../components/outputshellservertoolitemaction.mdx) | :heavy_minus_sign: | N/A | | -| `arguments` | *OptionalNullable[str]* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | -| `call_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | -| `container_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | List[[components.OutputShellServerToolItemFile](../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | :heavy_minus_sign: | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputShellServerToolItemTypeOpenrouterShell](../components/outputshellservertoolitemtypeopenroutershell.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [Optional[components.OutputShellServerToolItemAction]](../components/outputshellservertoolitemaction.mdx) | ➖ | N/A | | +| `arguments` | *OptionalNullable[str]* | ➖ | The raw tool-call arguments string as emitted by the model. | | +| `call_id` | *OptionalNullable[str]* | ➖ | The model-generated tool call id from the originating turn. | | +| `container_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | List[[components.OutputShellServerToolItemFile](../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` | *Optional[str]* | ➖ | N/A | | +| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | ➖ | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputShellServerToolItemTypeOpenrouterShell](../components/outputshellservertoolitemtypeopenroutershell.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputshellservertoolitemaction.mdx b/docs/components/outputshellservertoolitemaction.mdx index 56f9a9add..7397736af 100644 --- a/docs/components/outputshellservertoolitemaction.mdx +++ b/docs/components/outputshellservertoolitemaction.mdx @@ -6,6 +6,6 @@ title: "OutputShellServerToolItemAction" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `commands` | List[*str*] | :heavy_check_mark: | N/A | -| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `timeout_ms` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `commands` | List[*str*] | ✅ | N/A | +| `max_output_length` | *OptionalNullable[int]* | ➖ | N/A | +| `timeout_ms` | *OptionalNullable[int]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/outputshellservertoolitemfile.mdx b/docs/components/outputshellservertoolitemfile.mdx index 699a13178..93b99738f 100644 --- a/docs/components/outputshellservertoolitemfile.mdx +++ b/docs/components/outputshellservertoolitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputShellServerToolItemFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | :heavy_check_mark: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.OutputShellServerToolItemTypeContainerFileCitation](../components/outputshellservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *str* | ✅ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `file_id` | *str* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `type` | [components.OutputShellServerToolItemTypeContainerFileCitation](../components/outputshellservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputsubagentservertoolitem.mdx b/docs/components/outputsubagentservertoolitem.mdx index b9f3820a1..bccce611d 100644 --- a/docs/components/outputsubagentservertoolitem.mdx +++ b/docs/components/outputsubagentservertoolitem.mdx @@ -9,14 +9,14 @@ An openrouter:subagent server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `instance_name` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Slug of the worker model that executed the task. | | -| `name` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | The worker model's result (the outcome text returned to the delegating model). | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `task_description` | *Optional[str]* | :heavy_minus_sign: | The task description the delegating model sent to the worker. | | -| `task_name` | *Optional[str]* | :heavy_minus_sign: | The short task identifier the delegating model supplied. | | -| `type` | [components.OutputSubagentServerToolItemType](../components/outputsubagentservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `call_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `instance_name` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Slug of the worker model that executed the task. | | +| `name` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | The worker model's result (the outcome text returned to the delegating model). | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `task_description` | *Optional[str]* | ➖ | The task description the delegating model sent to the worker. | | +| `task_name` | *Optional[str]* | ➖ | The short task identifier the delegating model supplied. | | +| `type` | [components.OutputSubagentServerToolItemType](../components/outputsubagentservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputtexteditorservertoolitem.mdx b/docs/components/outputtexteditorservertoolitem.mdx index 2739149f3..f10b6020e 100644 --- a/docs/components/outputtexteditorservertoolitem.mdx +++ b/docs/components/outputtexteditorservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:text_editor server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `command` | [Optional[components.Command]](../components/command.mdx) | :heavy_minus_sign: | N/A | | -| `file_path` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputTextEditorServerToolItemType](../components/outputtexteditorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `command` | [Optional[components.Command]](../components/command.mdx) | ➖ | N/A | | +| `file_path` | *Optional[str]* | ➖ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputTextEditorServerToolItemType](../components/outputtexteditorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputtokensdetails.mdx b/docs/components/outputtokensdetails.mdx index 9c9b6d592..a3f183f72 100644 --- a/docs/components/outputtokensdetails.mdx +++ b/docs/components/outputtokensdetails.mdx @@ -6,4 +6,4 @@ title: "OutputTokensDetails" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `reasoning_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `reasoning_tokens` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputtoolsearchcallitem.mdx b/docs/components/outputtoolsearchcallitem.mdx index c12730c02..ac0b9bb91 100644 --- a/docs/components/outputtoolsearchcallitem.mdx +++ b/docs/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` | *Optional[Any]* | :heavy_minus_sign: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `execution` | [components.OutputToolSearchCallItemExecution](../components/outputtoolsearchcallitemexecution.mdx) | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputToolSearchCallItemType](../components/outputtoolsearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *Optional[Any]* | ➖ | N/A | | +| `call_id` | *str* | ✅ | N/A | | +| `execution` | [components.OutputToolSearchCallItemExecution](../components/outputtoolsearchcallitemexecution.mdx) | ✅ | N/A | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputToolSearchCallItemType](../components/outputtoolsearchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputtoolsearchservertoolitem.mdx b/docs/components/outputtoolsearchservertoolitem.mdx index 8b20ba5e8..b3bf9c0bb 100644 --- a/docs/components/outputtoolsearchservertoolitem.mdx +++ b/docs/components/outputtoolsearchservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:tool_search server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `matches` | List[[components.Match](../components/match.mdx)] | :heavy_minus_sign: | N/A | | -| `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputToolSearchServerToolItemType](../components/outputtoolsearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `error` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | +| `matches` | List[[components.Match](../components/match.mdx)] | ➖ | N/A | | +| `query` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputToolSearchServerToolItemType](../components/outputtoolsearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputwebfetchservertoolitem.mdx b/docs/components/outputwebfetchservertoolitem.mdx index 9c045b8b4..888a84f5f 100644 --- a/docs/components/outputwebfetchservertoolitem.mdx +++ b/docs/components/outputwebfetchservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:web_fetch server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `error` | *Optional[str]* | :heavy_minus_sign: | The error message if the fetch failed. | | -| `http_status` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputWebFetchServerToolItemType](../components/outputwebfetchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | -| `url` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `content` | *Optional[str]* | ➖ | N/A | | +| `error` | *Optional[str]* | ➖ | The error message if the fetch failed. | | +| `http_status` | *Optional[int]* | ➖ | The HTTP status code returned by the upstream URL fetch. | | +| `id` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.ToolCallStatus](../components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `title` | *Optional[str]* | ➖ | N/A | | +| `type` | [components.OutputWebFetchServerToolItemType](../components/outputwebfetchservertoolitemtype.mdx) | ✅ | N/A | | +| `url` | *Optional[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/outputwebsearchcallitem.mdx b/docs/components/outputwebsearchcallitem.mdx index 01c05d15b..cdf94d40f 100644 --- a/docs/components/outputwebsearchcallitem.mdx +++ b/docs/components/outputwebsearchcallitem.mdx @@ -6,8 +6,8 @@ title: "OutputWebSearchCallItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [Optional[components.OutputWebSearchCallItemActionUnion]](../components/outputwebsearchcallitemactionunion.mdx) | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputWebSearchCallItemTypeWebSearchCall](../components/outputwebsearchcallitemtypewebsearchcall.mdx) | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *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` | [Optional[components.OutputWebSearchCallItemActionUnion]](../components/outputwebsearchcallitemactionunion.mdx) | ➖ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `status` | [components.WebSearchStatus](../components/websearchstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputWebSearchCallItemTypeWebSearchCall](../components/outputwebsearchcallitemtypewebsearchcall.mdx) | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *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/components/outputwebsearchcallitemactionfindinpage.mdx b/docs/components/outputwebsearchcallitemactionfindinpage.mdx index 34fdc6f81..4561c8a5d 100644 --- a/docs/components/outputwebsearchcallitemactionfindinpage.mdx +++ b/docs/components/outputwebsearchcallitemactionfindinpage.mdx @@ -6,6 +6,6 @@ title: "OutputWebSearchCallItemActionFindInPage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `pattern` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.OutputWebSearchCallItemTypeFindInPage](../components/outputwebsearchcallitemtypefindinpage.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `pattern` | *str* | ✅ | N/A | +| `type` | [components.OutputWebSearchCallItemTypeFindInPage](../components/outputwebsearchcallitemtypefindinpage.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputwebsearchcallitemactionopenpage.mdx b/docs/components/outputwebsearchcallitemactionopenpage.mdx index 020201843..a957aceb8 100644 --- a/docs/components/outputwebsearchcallitemactionopenpage.mdx +++ b/docs/components/outputwebsearchcallitemactionopenpage.mdx @@ -6,5 +6,5 @@ title: "OutputWebSearchCallItemActionOpenPage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `type` | [components.OutputWebSearchCallItemTypeOpenPage](../components/outputwebsearchcallitemtypeopenpage.mdx) | :heavy_check_mark: | N/A | -| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [components.OutputWebSearchCallItemTypeOpenPage](../components/outputwebsearchcallitemtypeopenpage.mdx) | ✅ | N/A | +| `url` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/outputwebsearchcallitemactionsearch.mdx b/docs/components/outputwebsearchcallitemactionsearch.mdx index 3e4513ec3..063b6c29f 100644 --- a/docs/components/outputwebsearchcallitemactionsearch.mdx +++ b/docs/components/outputwebsearchcallitemactionsearch.mdx @@ -6,7 +6,7 @@ title: "OutputWebSearchCallItemActionSearch" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `queries` | List[*str*] | :heavy_minus_sign: | N/A | -| `query` | *str* | :heavy_check_mark: | N/A | -| `sources` | List[[components.WebSearchSource](../components/websearchsource.mdx)] | :heavy_minus_sign: | N/A | -| `type` | [components.OutputWebSearchCallItemTypeSearch](../components/outputwebsearchcallitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `queries` | List[*str*] | ➖ | N/A | +| `query` | *str* | ✅ | N/A | +| `sources` | List[[components.WebSearchSource](../components/websearchsource.mdx)] | ➖ | N/A | +| `type` | [components.OutputWebSearchCallItemTypeSearch](../components/outputwebsearchcallitemtypesearch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputwebsearchservertoolitem.mdx b/docs/components/outputwebsearchservertoolitem.mdx index 0b1a60766..2e1dc4a0c 100644 --- a/docs/components/outputwebsearchservertoolitem.mdx +++ b/docs/components/outputwebsearchservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:web_search server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `action` | [Optional[components.OutputWebSearchServerToolItemAction]](../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` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [Optional[components.OutputWebSearchServerToolItemAction]](../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | N/A | | +| `status` | [components.FailableToolCallStatus](../components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/outputwebsearchservertoolitemaction.mdx b/docs/components/outputwebsearchservertoolitemaction.mdx index ca6a895cf..9b0834971 100644 --- a/docs/components/outputwebsearchservertoolitemaction.mdx +++ b/docs/components/outputwebsearchservertoolitemaction.mdx @@ -9,6 +9,6 @@ The search action performed, matching OpenAI web_search_call.action shape. Inclu | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `query` | *str* | :heavy_check_mark: | N/A | -| `sources` | List[[components.OutputWebSearchServerToolItemSource](../components/outputwebsearchservertoolitemsource.mdx)] | :heavy_minus_sign: | N/A | -| `type` | [components.OutputWebSearchServerToolItemTypeSearch](../components/outputwebsearchservertoolitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `query` | *str* | ✅ | N/A | +| `sources` | List[[components.OutputWebSearchServerToolItemSource](../components/outputwebsearchservertoolitemsource.mdx)] | ➖ | N/A | +| `type` | [components.OutputWebSearchServerToolItemTypeSearch](../components/outputwebsearchservertoolitemtypesearch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/outputwebsearchservertoolitemsource.mdx b/docs/components/outputwebsearchservertoolitemsource.mdx index 5c1f410d3..3cf7735a4 100644 --- a/docs/components/outputwebsearchservertoolitemsource.mdx +++ b/docs/components/outputwebsearchservertoolitemsource.mdx @@ -6,5 +6,5 @@ title: "OutputWebSearchServerToolItemSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.OutputWebSearchServerToolItemTypeURL](../components/outputwebsearchservertoolitemtypeurl.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.OutputWebSearchServerToolItemTypeURL](../components/outputwebsearchservertoolitemtypeurl.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/paretorouterplugin.mdx b/docs/components/paretorouterplugin.mdx index 94e222c89..719eb6134 100644 --- a/docs/components/paretorouterplugin.mdx +++ b/docs/components/paretorouterplugin.mdx @@ -6,8 +6,8 @@ title: "ParetoRouterPlugin" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | -| `id` | [components.ParetoRouterPluginID](../components/paretorouterpluginid.mdx) | :heavy_check_mark: | N/A | | -| `max_price` | *Optional[float]* | :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 | -| `min_coding_score` | *Optional[float]* | :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 | -| `price_source` | [Optional[components.PriceSource]](../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` | *Optional[bool]* | ➖ | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | +| `id` | [components.ParetoRouterPluginID](../components/paretorouterpluginid.mdx) | ✅ | N/A | | +| `max_price` | *Optional[float]* | ➖ | 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 | +| `min_coding_score` | *Optional[float]* | ➖ | 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 | +| `price_source` | [Optional[components.PriceSource]](../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/components/partialcoverage.mdx b/docs/components/partialcoverage.mdx index 7c7807b23..94b02d263 100644 --- a/docs/components/partialcoverage.mdx +++ b/docs/components/partialcoverage.mdx @@ -6,5 +6,5 @@ title: "PartialCoverage" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `models` | List[*str*] | :heavy_check_mark: | N/A | -| `point` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `models` | List[*str*] | ✅ | N/A | +| `point` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/payloadtoolargeresponseerrordata.mdx b/docs/components/payloadtoolargeresponseerrordata.mdx index bb7c7f6be..e5133395a 100644 --- a/docs/components/payloadtoolargeresponseerrordata.mdx +++ b/docs/components/payloadtoolargeresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for PayloadTooLargeResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/paymentrequiredresponseerrordata.mdx b/docs/components/paymentrequiredresponseerrordata.mdx index 225e28808..3827ce4ae 100644 --- a/docs/components/paymentrequiredresponseerrordata.mdx +++ b/docs/components/paymentrequiredresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for PaymentRequiredResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/pdfparseroptions.mdx b/docs/components/pdfparseroptions.mdx index 2e8305209..4f250cf60 100644 --- a/docs/components/pdfparseroptions.mdx +++ b/docs/components/pdfparseroptions.mdx @@ -9,4 +9,4 @@ Options for PDF parsing. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.PDFParserEngine]](../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` | [Optional[components.PDFParserEngine]](../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/components/pendingsafetycheck.mdx b/docs/components/pendingsafetycheck.mdx index 4d484ee8e..55ed485aa 100644 --- a/docs/components/pendingsafetycheck.mdx +++ b/docs/components/pendingsafetycheck.mdx @@ -6,6 +6,6 @@ title: "PendingSafetyCheck" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *str* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/percentilelatencycutoffs.mdx b/docs/components/percentilelatencycutoffs.mdx index 60b8ab278..62cbd38e3 100644 --- a/docs/components/percentilelatencycutoffs.mdx +++ b/docs/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[float]* | :heavy_minus_sign: | Maximum p50 latency (seconds) | -| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p75 latency (seconds) | -| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p90 latency (seconds) | -| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file +| `p50` | *OptionalNullable[float]* | ➖ | Maximum p50 latency (seconds) | +| `p75` | *OptionalNullable[float]* | ➖ | Maximum p75 latency (seconds) | +| `p90` | *OptionalNullable[float]* | ➖ | Maximum p90 latency (seconds) | +| `p99` | *OptionalNullable[float]* | ➖ | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/docs/components/percentilestats.mdx b/docs/components/percentilestats.mdx index ff5277c9c..eff62d28b 100644 --- a/docs/components/percentilestats.mdx +++ b/docs/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` | *float* | :heavy_check_mark: | Median (50th percentile) | 25.5 | -| `p75` | *float* | :heavy_check_mark: | 75th percentile | 35.2 | -| `p90` | *float* | :heavy_check_mark: | 90th percentile | 48.7 | -| `p99` | *float* | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file +| `p50` | *float* | ✅ | Median (50th percentile) | 25.5 | +| `p75` | *float* | ✅ | 75th percentile | 35.2 | +| `p90` | *float* | ✅ | 90th percentile | 48.7 | +| `p99` | *float* | ✅ | 99th percentile | 85.3 | \ No newline at end of file diff --git a/docs/components/percentilethroughputcutoffs.mdx b/docs/components/percentilethroughputcutoffs.mdx index 86ea31294..fac1d15bc 100644 --- a/docs/components/percentilethroughputcutoffs.mdx +++ b/docs/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[float]* | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | -| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | -| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | -| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file +| `p50` | *OptionalNullable[float]* | ➖ | Minimum p50 throughput (tokens/sec) | +| `p75` | *OptionalNullable[float]* | ➖ | Minimum p75 throughput (tokens/sec) | +| `p90` | *OptionalNullable[float]* | ➖ | Minimum p90 throughput (tokens/sec) | +| `p99` | *OptionalNullable[float]* | ➖ | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/docs/components/perflast30mbyworkload.mdx b/docs/components/perflast30mbyworkload.mdx index 193447130..fcb436a59 100644 --- a/docs/components/perflast30mbyworkload.mdx +++ b/docs/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` | [Optional[components.Decisions]](../components/decisions.mdx) | :heavy_minus_sign: | N/A | -| `embeddings` | [Optional[components.Embeddings]](../components/embeddings.mdx) | :heavy_minus_sign: | N/A | -| `image_generation` | [Optional[components.ImageGeneration]](../components/imagegeneration.mdx) | :heavy_minus_sign: | N/A | -| `rerank` | [Optional[components.Rerank]](../components/rerank.mdx) | :heavy_minus_sign: | N/A | -| `stt` | [Optional[components.STT]](../components/stt.mdx) | :heavy_minus_sign: | N/A | -| `text_generation` | [Optional[components.TextGeneration]](../components/textgeneration.mdx) | :heavy_minus_sign: | N/A | -| `tts` | [Optional[components.TTS]](../components/tts.mdx) | :heavy_minus_sign: | N/A | -| `unknown` | [Optional[components.Unknown]](../components/unknown.mdx) | :heavy_minus_sign: | N/A | -| `video_generation` | [Optional[components.VideoGeneration]](../components/videogeneration.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `decisions` | [Optional[components.Decisions]](../components/decisions.mdx) | ➖ | N/A | +| `embeddings` | [Optional[components.Embeddings]](../components/embeddings.mdx) | ➖ | N/A | +| `image_generation` | [Optional[components.ImageGeneration]](../components/imagegeneration.mdx) | ➖ | N/A | +| `rerank` | [Optional[components.Rerank]](../components/rerank.mdx) | ➖ | N/A | +| `stt` | [Optional[components.STT]](../components/stt.mdx) | ➖ | N/A | +| `text_generation` | [Optional[components.TextGeneration]](../components/textgeneration.mdx) | ➖ | N/A | +| `tts` | [Optional[components.TTS]](../components/tts.mdx) | ➖ | N/A | +| `unknown` | [Optional[components.Unknown]](../components/unknown.mdx) | ➖ | N/A | +| `video_generation` | [Optional[components.VideoGeneration]](../components/videogeneration.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/perrequestlimits.mdx b/docs/components/perrequestlimits.mdx index c03fb6fb6..9b1550fb9 100644 --- a/docs/components/perrequestlimits.mdx +++ b/docs/components/perrequestlimits.mdx @@ -9,5 +9,5 @@ Per-request token limits | Field | Type | Required | Description | Example | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `completion_tokens` | *float* | :heavy_check_mark: | Maximum completion tokens per request | 1000 | -| `prompt_tokens` | *float* | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | \ No newline at end of file +| `completion_tokens` | *float* | ✅ | Maximum completion tokens per request | 1000 | +| `prompt_tokens` | *float* | ✅ | Maximum prompt tokens per request | 1000 | \ No newline at end of file diff --git a/docs/components/pipelinestage.mdx b/docs/components/pipelinestage.mdx index 2f7a26c02..2966e9054 100644 --- a/docs/components/pipelinestage.mdx +++ b/docs/components/pipelinestage.mdx @@ -6,10 +6,10 @@ title: "PipelineStage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cost_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `data` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `guardrail_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `guardrail_scope` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.PipelineStageType](../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 +| `cost_usd` | *OptionalNullable[float]* | ➖ | N/A | | +| `data` | Dict[str, *Any*] | ➖ | N/A | | +| `guardrail_id` | *Optional[str]* | ➖ | N/A | | +| `guardrail_scope` | *Optional[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `summary` | *Optional[str]* | ➖ | N/A | | +| `type` | [components.PipelineStageType](../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/components/prediction.mdx b/docs/components/prediction.mdx index 6164a9fa7..89ba5ec28 100644 --- a/docs/components/prediction.mdx +++ b/docs/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](../components/predictioncontent.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.PredictionType](../components/predictiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | [components.PredictionContent](../components/predictioncontent.mdx) | ✅ | N/A | +| `type` | [components.PredictionType](../components/predictiontype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/predictioncontenttext.mdx b/docs/components/predictioncontenttext.mdx index 541026eaa..ddd01c9e0 100644 --- a/docs/components/predictioncontenttext.mdx +++ b/docs/components/predictioncontenttext.mdx @@ -9,5 +9,5 @@ Text content part for a predicted output. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.PredictionContentTextType](../components/predictioncontenttexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *str* | ✅ | N/A | +| `type` | [components.PredictionContentTextType](../components/predictioncontenttexttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/preset.mdx b/docs/components/preset.mdx index af18885fe..7d4874e2f 100644 --- a/docs/components/preset.mdx +++ b/docs/components/preset.mdx @@ -9,14 +9,14 @@ A preset without version details. | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | N/A | | -| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `description` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `designated_version_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.PresetStatus](../components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | -| `status_updated_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | N/A | | -| `workspace_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `created_at` | *str* | ✅ | N/A | | +| `creator_user_id` | *Nullable[str]* | ✅ | N/A | | +| `description` | *Nullable[str]* | ✅ | N/A | | +| `designated_version_id` | *Nullable[str]* | ✅ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `slug` | *str* | ✅ | N/A | | +| `status` | [components.PresetStatus](../components/presetstatus.mdx) | ✅ | The status of a preset. | active | +| `status_updated_at` | *Nullable[str]* | ✅ | N/A | | +| `updated_at` | *str* | ✅ | N/A | | +| `workspace_id` | *Nullable[str]* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/presetdesignatedversion.mdx b/docs/components/presetdesignatedversion.mdx index 5c5675bea..50a127bac 100644 --- a/docs/components/presetdesignatedversion.mdx +++ b/docs/components/presetdesignatedversion.mdx @@ -9,11 +9,11 @@ A specific version of a preset, containing config and optional system prompt. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `config` | Dict[str, *Any*] | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `creator_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `preset_id` | *str* | :heavy_check_mark: | N/A | -| `system_prompt` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | -| `version` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `config` | Dict[str, *Any*] | ✅ | N/A | +| `created_at` | *str* | ✅ | N/A | +| `creator_id` | *str* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `preset_id` | *str* | ✅ | N/A | +| `system_prompt` | *Nullable[str]* | ✅ | N/A | +| `updated_at` | *str* | ✅ | N/A | +| `version` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/presetwithdesignatedversion.mdx b/docs/components/presetwithdesignatedversion.mdx index 56d189d99..442a603f9 100644 --- a/docs/components/presetwithdesignatedversion.mdx +++ b/docs/components/presetwithdesignatedversion.mdx @@ -9,15 +9,15 @@ A preset with its currently designated version. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | N/A | | -| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `description` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `designated_version_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.PresetStatus](../components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | -| `status_updated_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | N/A | | -| `workspace_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `designated_version` | [Nullable[components.PresetDesignatedVersion]](../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 +| `created_at` | *str* | ✅ | N/A | | +| `creator_user_id` | *Nullable[str]* | ✅ | N/A | | +| `description` | *Nullable[str]* | ✅ | N/A | | +| `designated_version_id` | *Nullable[str]* | ✅ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `slug` | *str* | ✅ | N/A | | +| `status` | [components.PresetStatus](../components/presetstatus.mdx) | ✅ | The status of a preset. | active | +| `status_updated_at` | *Nullable[str]* | ✅ | N/A | | +| `updated_at` | *str* | ✅ | N/A | | +| `workspace_id` | *Nullable[str]* | ✅ | N/A | | +| `designated_version` | [Nullable[components.PresetDesignatedVersion]](../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/components/preview20250311websearchservertool.mdx b/docs/components/preview20250311websearchservertool.mdx index 750580a39..7931387fd 100644 --- a/docs/components/preview20250311websearchservertool.mdx +++ b/docs/components/preview20250311websearchservertool.mdx @@ -9,12 +9,12 @@ Web search preview tool configuration (2025-03-11 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `max_results` | *Optional[int]* | :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 | -| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [components.Preview20250311WebSearchServerToolType](../components/preview20250311websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `max_results` | *Optional[int]* | ➖ | 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 | +| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `type` | [components.Preview20250311WebSearchServerToolType](../components/preview20250311websearchservertooltype.mdx) | ✅ | N/A | | +| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/previewwebsearchservertool.mdx b/docs/components/previewwebsearchservertool.mdx index ccbdb6a61..6f6212a0b 100644 --- a/docs/components/previewwebsearchservertool.mdx +++ b/docs/components/previewwebsearchservertool.mdx @@ -9,12 +9,12 @@ Web search preview tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `max_results` | *Optional[int]* | :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 | -| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [components.PreviewWebSearchServerToolType](../components/previewwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `max_results` | *Optional[int]* | ➖ | 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 | +| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `type` | [components.PreviewWebSearchServerToolType](../components/previewwebsearchservertooltype.mdx) | ✅ | N/A | | +| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/previewwebsearchuserlocation.mdx b/docs/components/previewwebsearchuserlocation.mdx index 1695e4049..e95372301 100644 --- a/docs/components/previewwebsearchuserlocation.mdx +++ b/docs/components/previewwebsearchuserlocation.mdx @@ -6,8 +6,8 @@ title: "PreviewWebSearchUserLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.PreviewWebSearchUserLocationType](../components/previewwebsearchuserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | ➖ | N/A | +| `country` | *OptionalNullable[str]* | ➖ | N/A | +| `region` | *OptionalNullable[str]* | ➖ | N/A | +| `timezone` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.PreviewWebSearchUserLocationType](../components/previewwebsearchuserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/pricing.mdx b/docs/components/pricing.mdx index e60ec6cfd..cc6ad3ed9 100644 --- a/docs/components/pricing.mdx +++ b/docs/components/pricing.mdx @@ -6,19 +6,19 @@ title: "Pricing" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `audio` | *Optional[str]* | :heavy_minus_sign: | Price in USD per audio input token | -| `audio_output` | *Optional[str]* | :heavy_minus_sign: | Price in USD per audio output token | -| `completion` | *str* | :heavy_check_mark: | Price in USD per token for completion (output) generation | -| `discount` | *Optional[float]* | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `image` | *Optional[str]* | :heavy_minus_sign: | Price in USD per input image | -| `image_output` | *Optional[str]* | :heavy_minus_sign: | Price in USD per output image | -| `image_token` | *Optional[str]* | :heavy_minus_sign: | Price in USD per image token | -| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | Price in USD per cached audio input token | -| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | Price in USD per cached input token (read) | -| `input_cache_write` | *Optional[str]* | :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. | -| `input_cache_write_1h` | *Optional[str]* | :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. | -| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | Price in USD per internal reasoning token | -| `overrides` | List[[components.PricingOverride](../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` | *str* | :heavy_check_mark: | Price in USD per token for prompt (input) processing | -| `request` | *Optional[str]* | :heavy_minus_sign: | Price in USD per request | -| `web_search` | *Optional[str]* | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file +| `audio` | *Optional[str]* | ➖ | Price in USD per audio input token | +| `audio_output` | *Optional[str]* | ➖ | Price in USD per audio output token | +| `completion` | *str* | ✅ | Price in USD per token for completion (output) generation | +| `discount` | *Optional[float]* | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `image` | *Optional[str]* | ➖ | Price in USD per input image | +| `image_output` | *Optional[str]* | ➖ | Price in USD per output image | +| `image_token` | *Optional[str]* | ➖ | Price in USD per image token | +| `input_audio_cache` | *Optional[str]* | ➖ | Price in USD per cached audio input token | +| `input_cache_read` | *Optional[str]* | ➖ | Price in USD per cached input token (read) | +| `input_cache_write` | *Optional[str]* | ➖ | 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. | +| `input_cache_write_1h` | *Optional[str]* | ➖ | 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. | +| `internal_reasoning` | *Optional[str]* | ➖ | Price in USD per internal reasoning token | +| `overrides` | List[[components.PricingOverride](../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` | *str* | ✅ | Price in USD per token for prompt (input) processing | +| `request` | *Optional[str]* | ➖ | Price in USD per request | +| `web_search` | *Optional[str]* | ➖ | Price in USD per web search | \ No newline at end of file diff --git a/docs/components/pricingoverride.mdx b/docs/components/pricingoverride.mdx index b7d539e20..a233ad3c5 100644 --- a/docs/components/pricingoverride.mdx +++ b/docs/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` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per audio input token | -| `completion` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per token for completion (output) generation | -| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per cached audio input token | -| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per cached input token (read) | -| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per cache-write token | -| `input_cache_write_1h` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per 1-hour cache-write token | -| `min_prompt_tokens` | *Optional[float]* | :heavy_minus_sign: | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | -| `prompt` | *Optional[str]* | :heavy_minus_sign: | Overridden price in USD per token for prompt (input) processing | -| `utc_days` | List[[components.UtcDay](../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. | -| `utc_end` | *Optional[float]* | :heavy_minus_sign: | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | -| `utc_start` | *Optional[float]* | :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` | *Optional[str]* | ➖ | Overridden price in USD per audio input token | +| `completion` | *Optional[str]* | ➖ | Overridden price in USD per token for completion (output) generation | +| `input_audio_cache` | *Optional[str]* | ➖ | Overridden price in USD per cached audio input token | +| `input_cache_read` | *Optional[str]* | ➖ | Overridden price in USD per cached input token (read) | +| `input_cache_write` | *Optional[str]* | ➖ | Overridden price in USD per cache-write token | +| `input_cache_write_1h` | *Optional[str]* | ➖ | Overridden price in USD per 1-hour cache-write token | +| `min_prompt_tokens` | *Optional[float]* | ➖ | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | +| `prompt` | *Optional[str]* | ➖ | Overridden price in USD per token for prompt (input) processing | +| `utc_days` | List[[components.UtcDay](../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. | +| `utc_end` | *Optional[float]* | ➖ | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | +| `utc_start` | *Optional[float]* | ➖ | 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/components/privateendpoint.mdx b/docs/components/privateendpoint.mdx index 89ec31591..926be8291 100644 --- a/docs/components/privateendpoint.mdx +++ b/docs/components/privateendpoint.mdx @@ -6,15 +6,15 @@ title: "PrivateEndpoint" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `base_url` | *Nullable[str]* | :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 | -| `declared_region` | [Nullable[components.PrivateEndpointDeclaredRegion]](../components/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `declared_zdr` | *Nullable[bool]* | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `model_name` | *Nullable[str]* | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `model_slug` | *Nullable[str]* | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `pricing` | [components.PrivateEndpointPricing](../components/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `provider_name` | *str* | :heavy_check_mark: | Display name of the upstream provider. | Azure | -| `provider_slug` | *Nullable[str]* | :heavy_check_mark: | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | -| `status` | [components.PrivateEndpointStatus](../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 | -| `upstream_model_id` | *str* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `base_url` | *Nullable[str]* | ✅ | 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 | +| `declared_region` | [Nullable[components.PrivateEndpointDeclaredRegion]](../components/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `declared_zdr` | *Nullable[bool]* | ✅ | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `model_name` | *Nullable[str]* | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `model_slug` | *Nullable[str]* | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `pricing` | [components.PrivateEndpointPricing](../components/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `provider_name` | *str* | ✅ | Display name of the upstream provider. | Azure | +| `provider_slug` | *Nullable[str]* | ✅ | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | +| `status` | [components.PrivateEndpointStatus](../components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | +| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/components/privateendpointactivation.mdx b/docs/components/privateendpointactivation.mdx index 22af2c3b4..724baa31c 100644 --- a/docs/components/privateendpointactivation.mdx +++ b/docs/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 | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `workspace_id` | *str* | :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 +| `workspace_id` | *str* | ✅ | 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/components/privateendpointcheck.mdx b/docs/components/privateendpointcheck.mdx index 2131ef57c..1648e5555 100644 --- a/docs/components/privateendpointcheck.mdx +++ b/docs/components/privateendpointcheck.mdx @@ -6,9 +6,9 @@ title: "PrivateEndpointCheck" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `actual_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Model the upstream reported serving, when it differs from the request. | | -| `name` | *str* | :heavy_check_mark: | Check name. | auth_ok | -| `passed` | *bool* | :heavy_check_mark: | N/A | | -| `reason` | [Optional[components.PrivateEndpointCheckReason]](../components/privateendpointcheckreason.mdx) | :heavy_minus_sign: | Why the check failed. | no_byok_key | -| `upstream_message` | *OptionalNullable[str]* | :heavy_minus_sign: | Error message returned by your deployment when the call failed. | | -| `upstream_status` | *Optional[int]* | :heavy_minus_sign: | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file +| `actual_model` | *OptionalNullable[str]* | ➖ | Model the upstream reported serving, when it differs from the request. | | +| `name` | *str* | ✅ | Check name. | auth_ok | +| `passed` | *bool* | ✅ | N/A | | +| `reason` | [Optional[components.PrivateEndpointCheckReason]](../components/privateendpointcheckreason.mdx) | ➖ | Why the check failed. | no_byok_key | +| `upstream_message` | *OptionalNullable[str]* | ➖ | Error message returned by your deployment when the call failed. | | +| `upstream_status` | *Optional[int]* | ➖ | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file diff --git a/docs/components/privateendpointpricing.mdx b/docs/components/privateendpointpricing.mdx index 15a8329bc..479c40072 100644 --- a/docs/components/privateendpointpricing.mdx +++ b/docs/components/privateendpointpricing.mdx @@ -9,5 +9,5 @@ Negotiated per-token rates reported for requests routed to this endpoint. | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `completion` | *str* | :heavy_check_mark: | USD per completion token, as a decimal string. | 0.00001 | -| `prompt` | *str* | :heavy_check_mark: | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file +| `completion` | *str* | ✅ | USD per completion token, as a decimal string. | 0.00001 | +| `prompt` | *str* | ✅ | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file diff --git a/docs/components/privateendpointresponse.mdx b/docs/components/privateendpointresponse.mdx index ebc7588e0..f40498bbd 100644 --- a/docs/components/privateendpointresponse.mdx +++ b/docs/components/privateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "PrivateEndpointResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.PrivateEndpoint](../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](../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/components/privateendpointsummary.mdx b/docs/components/privateendpointsummary.mdx index d88a936da..7baf7c994 100644 --- a/docs/components/privateendpointsummary.mdx +++ b/docs/components/privateendpointsummary.mdx @@ -6,10 +6,10 @@ title: "PrivateEndpointSummary" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `model_name` | *Nullable[str]* | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `model_slug` | *Nullable[str]* | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `provider_name` | *str* | :heavy_check_mark: | Display name of the upstream provider. | Azure | -| `status` | [components.PrivateEndpointStatus](../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 +| `created_at` | *str* | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `model_name` | *Nullable[str]* | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `model_slug` | *Nullable[str]* | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `provider_name` | *str* | ✅ | Display name of the upstream provider. | Azure | +| `status` | [components.PrivateEndpointStatus](../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/components/privateendpointvalidation.mdx b/docs/components/privateendpointvalidation.mdx index dd31ec90b..e0037589a 100644 --- a/docs/components/privateendpointvalidation.mdx +++ b/docs/components/privateendpointvalidation.mdx @@ -6,5 +6,5 @@ title: "PrivateEndpointValidation" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `checks` | List[[components.PrivateEndpointCheck](../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` | List[[components.PrivateEndpointCheck](../components/privateendpointcheck.mdx)] | ✅ | N/A | | +| `passed` | *bool* | ✅ | Whether every check passed. | true | \ No newline at end of file diff --git a/docs/components/privateendpointvalidationnullable.mdx b/docs/components/privateendpointvalidationnullable.mdx index a7e2dfdc1..b677c603b 100644 --- a/docs/components/privateendpointvalidationnullable.mdx +++ b/docs/components/privateendpointvalidationnullable.mdx @@ -6,5 +6,5 @@ title: "PrivateEndpointValidationNullable" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `checks` | List[[components.PrivateEndpointCheck](../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` | List[[components.PrivateEndpointCheck](../components/privateendpointcheck.mdx)] | ✅ | N/A | | +| `passed` | *bool* | ✅ | Whether every check passed. | true | \ No newline at end of file diff --git a/docs/components/privateendpointvalidationresponse.mdx b/docs/components/privateendpointvalidationresponse.mdx index 97db30857..d72ba5c13 100644 --- a/docs/components/privateendpointvalidationresponse.mdx +++ b/docs/components/privateendpointvalidationresponse.mdx @@ -6,4 +6,4 @@ title: "PrivateEndpointValidationResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `data` | [components.PrivateEndpointValidation](../components/privateendpointvalidation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.PrivateEndpointValidation](../components/privateendpointvalidation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/progress.mdx b/docs/components/progress.mdx index 1c5f4b732..bf32f73ec 100644 --- a/docs/components/progress.mdx +++ b/docs/components/progress.mdx @@ -9,6 +9,6 @@ Active provisioning step, or null once provisioning has settled. | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `step_label` | *str* | :heavy_check_mark: | Human-readable label of the active provisioning step. | -| `step_number` | *int* | :heavy_check_mark: | One-based index of the active step. | -| `total_steps` | *int* | :heavy_check_mark: | Number of provisioning steps. | \ No newline at end of file +| `step_label` | *str* | ✅ | Human-readable label of the active provisioning step. | +| `step_number` | *int* | ✅ | One-based index of the active step. | +| `total_steps` | *int* | ✅ | Number of provisioning steps. | \ No newline at end of file diff --git a/docs/components/promptcachebreakpoint.mdx b/docs/components/promptcachebreakpoint.mdx index 313ab84d0..d05c026de 100644 --- a/docs/components/promptcachebreakpoint.mdx +++ b/docs/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](../components/promptcachebreakpointmode.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `mode` | [components.PromptCacheBreakpointMode](../components/promptcachebreakpointmode.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/promptcacheoptions.mdx b/docs/components/promptcacheoptions.mdx index a9b20d3f9..4d05fd3b0 100644 --- a/docs/components/promptcacheoptions.mdx +++ b/docs/components/promptcacheoptions.mdx @@ -9,5 +9,5 @@ Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `mode` | [components.PromptCacheOptionsMode](../components/promptcacheoptionsmode.mdx) | :heavy_check_mark: | N/A | -| `ttl` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `mode` | [components.PromptCacheOptionsMode](../components/promptcacheoptionsmode.mdx) | ✅ | N/A | +| `ttl` | *OptionalNullable[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/provideroptions.mdx b/docs/components/provideroptions.mdx index cb5a52ce9..72536c549 100644 --- a/docs/components/provideroptions.mdx +++ b/docs/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` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ai21` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `aion_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `akashml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `alibaba` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `amazon_bedrock` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `amazon_nova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ambient` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `anthropic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `anthropic_2` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `anyscale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `arcee_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `assemblyai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `atlas_cloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `atoma` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `avian` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `azure` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `baidu` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `baseten` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `black_forest_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `byteplus` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `centml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cerebras` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `chutes` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cirrascale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `clarifai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cloudflare` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cohere` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `coreweave` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cosine` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `crofai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `crucible` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `crusoe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `darkbloom` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `databricks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `decart` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deepgram` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deepinfra` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deepseek` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `dekallm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `digitalocean` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `elevenlabs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `enfer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `fake_provider` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `featherless` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `fireworks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `fish_audio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `friendli` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `gmicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `google_ai_studio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `google_vertex` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `gopomelo` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `groq` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `heygen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `huggingface` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `hyperbolic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `hyperbolic_quantized` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inception` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inferact_vllm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inference_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `infermatic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inocloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `io_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ionstream` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `klusterai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `krea` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lambda_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lepton` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `liquid` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lynn` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lynn_private` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `makora` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mancer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mancer_old` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mara` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `meta` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `minimax` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mistral` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `modal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `modelrun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `modular` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `moonshotai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `morph` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ncompass` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `near_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nebius` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nex_agi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nextbit` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nineteen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `novita` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nvidia` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `octoai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ollama` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `open_inference` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `openai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `parasail` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `perceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `perplexity` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `phala` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `poolside` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `primeintellect` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `quiver` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `recraft` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `recursal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `reflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `reka` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `relace` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `replicate` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `respan` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `runway` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sail_research` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sakana` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sakana_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sambanova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sambanova_cloaked` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `scaledown` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `seed` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sf_compute` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `siliconflow` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sourceful` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `stealth` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `stepfun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `streamlake` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `switchpoint` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `targon` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `tencent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `tenstorrent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `thinkingmachines` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `together` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `together_lite` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `typesafe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ubicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `unbiased` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `upstage` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `venice` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `voyageai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `wafer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `wandb` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `wandb_legacy` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `xai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `xiaomi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `z_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `oneai` | Dict[str, *Any*] | ➖ | N/A | +| `ai21` | Dict[str, *Any*] | ➖ | N/A | +| `aion_labs` | Dict[str, *Any*] | ➖ | N/A | +| `akashml` | Dict[str, *Any*] | ➖ | N/A | +| `alibaba` | Dict[str, *Any*] | ➖ | N/A | +| `amazon_bedrock` | Dict[str, *Any*] | ➖ | N/A | +| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | +| `amazon_nova` | Dict[str, *Any*] | ➖ | N/A | +| `ambient` | Dict[str, *Any*] | ➖ | N/A | +| `anthropic` | Dict[str, *Any*] | ➖ | N/A | +| `anthropic_2` | Dict[str, *Any*] | ➖ | N/A | +| `anyscale` | Dict[str, *Any*] | ➖ | N/A | +| `arcee_ai` | Dict[str, *Any*] | ➖ | N/A | +| `assemblyai` | Dict[str, *Any*] | ➖ | N/A | +| `atlas_cloud` | Dict[str, *Any*] | ➖ | N/A | +| `atoma` | Dict[str, *Any*] | ➖ | N/A | +| `avian` | Dict[str, *Any*] | ➖ | N/A | +| `azure` | Dict[str, *Any*] | ➖ | N/A | +| `baidu` | Dict[str, *Any*] | ➖ | N/A | +| `baseten` | Dict[str, *Any*] | ➖ | N/A | +| `black_forest_labs` | Dict[str, *Any*] | ➖ | N/A | +| `byteplus` | Dict[str, *Any*] | ➖ | N/A | +| `centml` | Dict[str, *Any*] | ➖ | N/A | +| `cerebras` | Dict[str, *Any*] | ➖ | N/A | +| `chutes` | Dict[str, *Any*] | ➖ | N/A | +| `cirrascale` | Dict[str, *Any*] | ➖ | N/A | +| `clarifai` | Dict[str, *Any*] | ➖ | N/A | +| `claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | +| `cloudflare` | Dict[str, *Any*] | ➖ | N/A | +| `cohere` | Dict[str, *Any*] | ➖ | N/A | +| `coreweave` | Dict[str, *Any*] | ➖ | N/A | +| `cosine` | Dict[str, *Any*] | ➖ | N/A | +| `crofai` | Dict[str, *Any*] | ➖ | N/A | +| `crucible` | Dict[str, *Any*] | ➖ | N/A | +| `crusoe` | Dict[str, *Any*] | ➖ | N/A | +| `darkbloom` | Dict[str, *Any*] | ➖ | N/A | +| `databricks` | Dict[str, *Any*] | ➖ | N/A | +| `decart` | Dict[str, *Any*] | ➖ | N/A | +| `deepgram` | Dict[str, *Any*] | ➖ | N/A | +| `deepinfra` | Dict[str, *Any*] | ➖ | N/A | +| `deepseek` | Dict[str, *Any*] | ➖ | N/A | +| `dekallm` | Dict[str, *Any*] | ➖ | N/A | +| `digitalocean` | Dict[str, *Any*] | ➖ | N/A | +| `elevenlabs` | Dict[str, *Any*] | ➖ | N/A | +| `enfer` | Dict[str, *Any*] | ➖ | N/A | +| `fake_provider` | Dict[str, *Any*] | ➖ | N/A | +| `featherless` | Dict[str, *Any*] | ➖ | N/A | +| `fireworks` | Dict[str, *Any*] | ➖ | N/A | +| `fish_audio` | Dict[str, *Any*] | ➖ | N/A | +| `friendli` | Dict[str, *Any*] | ➖ | N/A | +| `gmicloud` | Dict[str, *Any*] | ➖ | N/A | +| `google_ai_studio` | Dict[str, *Any*] | ➖ | N/A | +| `google_vertex` | Dict[str, *Any*] | ➖ | N/A | +| `gopomelo` | Dict[str, *Any*] | ➖ | N/A | +| `groq` | Dict[str, *Any*] | ➖ | N/A | +| `heygen` | Dict[str, *Any*] | ➖ | N/A | +| `huggingface` | Dict[str, *Any*] | ➖ | N/A | +| `hyperbolic` | Dict[str, *Any*] | ➖ | N/A | +| `hyperbolic_quantized` | Dict[str, *Any*] | ➖ | N/A | +| `inception` | Dict[str, *Any*] | ➖ | N/A | +| `inceptron` | Dict[str, *Any*] | ➖ | N/A | +| `inferact_vllm` | Dict[str, *Any*] | ➖ | N/A | +| `inference_net` | Dict[str, *Any*] | ➖ | N/A | +| `infermatic` | Dict[str, *Any*] | ➖ | N/A | +| `inflection` | Dict[str, *Any*] | ➖ | N/A | +| `inocloud` | Dict[str, *Any*] | ➖ | N/A | +| `io_net` | Dict[str, *Any*] | ➖ | N/A | +| `ionstream` | Dict[str, *Any*] | ➖ | N/A | +| `klusterai` | Dict[str, *Any*] | ➖ | N/A | +| `krea` | Dict[str, *Any*] | ➖ | N/A | +| `lambda_` | Dict[str, *Any*] | ➖ | N/A | +| `lepton` | Dict[str, *Any*] | ➖ | N/A | +| `liquid` | Dict[str, *Any*] | ➖ | N/A | +| `lynn` | Dict[str, *Any*] | ➖ | N/A | +| `lynn_private` | Dict[str, *Any*] | ➖ | N/A | +| `makora` | Dict[str, *Any*] | ➖ | N/A | +| `mancer` | Dict[str, *Any*] | ➖ | N/A | +| `mancer_old` | Dict[str, *Any*] | ➖ | N/A | +| `mara` | Dict[str, *Any*] | ➖ | N/A | +| `meta` | Dict[str, *Any*] | ➖ | N/A | +| `minimax` | Dict[str, *Any*] | ➖ | N/A | +| `mistral` | Dict[str, *Any*] | ➖ | N/A | +| `modal` | Dict[str, *Any*] | ➖ | N/A | +| `modelrun` | Dict[str, *Any*] | ➖ | N/A | +| `modular` | Dict[str, *Any*] | ➖ | N/A | +| `moonshotai` | Dict[str, *Any*] | ➖ | N/A | +| `morph` | Dict[str, *Any*] | ➖ | N/A | +| `ncompass` | Dict[str, *Any*] | ➖ | N/A | +| `near_ai` | Dict[str, *Any*] | ➖ | N/A | +| `nebius` | Dict[str, *Any*] | ➖ | N/A | +| `nex_agi` | Dict[str, *Any*] | ➖ | N/A | +| `nextbit` | Dict[str, *Any*] | ➖ | N/A | +| `nineteen` | Dict[str, *Any*] | ➖ | N/A | +| `novita` | Dict[str, *Any*] | ➖ | N/A | +| `nvidia` | Dict[str, *Any*] | ➖ | N/A | +| `octoai` | Dict[str, *Any*] | ➖ | N/A | +| `ollama` | Dict[str, *Any*] | ➖ | N/A | +| `open_inference` | Dict[str, *Any*] | ➖ | N/A | +| `openai` | Dict[str, *Any*] | ➖ | N/A | +| `parasail` | Dict[str, *Any*] | ➖ | N/A | +| `perceptron` | Dict[str, *Any*] | ➖ | N/A | +| `perplexity` | Dict[str, *Any*] | ➖ | N/A | +| `phala` | Dict[str, *Any*] | ➖ | N/A | +| `poolside` | Dict[str, *Any*] | ➖ | N/A | +| `primeintellect` | Dict[str, *Any*] | ➖ | N/A | +| `quiver` | Dict[str, *Any*] | ➖ | N/A | +| `recraft` | Dict[str, *Any*] | ➖ | N/A | +| `recursal` | Dict[str, *Any*] | ➖ | N/A | +| `reflection` | Dict[str, *Any*] | ➖ | N/A | +| `reka` | Dict[str, *Any*] | ➖ | N/A | +| `relace` | Dict[str, *Any*] | ➖ | N/A | +| `replicate` | Dict[str, *Any*] | ➖ | N/A | +| `respan` | Dict[str, *Any*] | ➖ | N/A | +| `runway` | Dict[str, *Any*] | ➖ | N/A | +| `sail_research` | Dict[str, *Any*] | ➖ | N/A | +| `sakana` | Dict[str, *Any*] | ➖ | N/A | +| `sakana_ai` | Dict[str, *Any*] | ➖ | N/A | +| `sambanova` | Dict[str, *Any*] | ➖ | N/A | +| `sambanova_cloaked` | Dict[str, *Any*] | ➖ | N/A | +| `scaledown` | Dict[str, *Any*] | ➖ | N/A | +| `seed` | Dict[str, *Any*] | ➖ | N/A | +| `sf_compute` | Dict[str, *Any*] | ➖ | N/A | +| `siliconflow` | Dict[str, *Any*] | ➖ | N/A | +| `sourceful` | Dict[str, *Any*] | ➖ | N/A | +| `stealth` | Dict[str, *Any*] | ➖ | N/A | +| `stepfun` | Dict[str, *Any*] | ➖ | N/A | +| `streamlake` | Dict[str, *Any*] | ➖ | N/A | +| `switchpoint` | Dict[str, *Any*] | ➖ | N/A | +| `targon` | Dict[str, *Any*] | ➖ | N/A | +| `tencent` | Dict[str, *Any*] | ➖ | N/A | +| `tenstorrent` | Dict[str, *Any*] | ➖ | N/A | +| `thinkingmachines` | Dict[str, *Any*] | ➖ | N/A | +| `together` | Dict[str, *Any*] | ➖ | N/A | +| `together_lite` | Dict[str, *Any*] | ➖ | N/A | +| `typesafe` | Dict[str, *Any*] | ➖ | N/A | +| `ubicloud` | Dict[str, *Any*] | ➖ | N/A | +| `unbiased` | Dict[str, *Any*] | ➖ | N/A | +| `upstage` | Dict[str, *Any*] | ➖ | N/A | +| `venice` | Dict[str, *Any*] | ➖ | N/A | +| `voyageai` | Dict[str, *Any*] | ➖ | N/A | +| `wafer` | Dict[str, *Any*] | ➖ | N/A | +| `wandb` | Dict[str, *Any*] | ➖ | N/A | +| `wandb_legacy` | Dict[str, *Any*] | ➖ | N/A | +| `xai` | Dict[str, *Any*] | ➖ | N/A | +| `xiaomi` | Dict[str, *Any*] | ➖ | N/A | +| `z_ai` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/provideroverloadedresponseerrordata.mdx b/docs/components/provideroverloadedresponseerrordata.mdx index 8318f5211..26f853326 100644 --- a/docs/components/provideroverloadedresponseerrordata.mdx +++ b/docs/components/provideroverloadedresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ProviderOverloadedResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/providerpreferences.mdx b/docs/components/providerpreferences.mdx index 2ae5e4b4a..db7cd85be 100644 --- a/docs/components/providerpreferences.mdx +++ b/docs/components/providerpreferences.mdx @@ -9,17 +9,17 @@ Provider routing preferences for the request. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allow_fallbacks` | *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.
| | -| `data_collection` | [OptionalNullable[components.DataCollection]](../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 | -| `enforce_distillable_text` | *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` | List[[components.ProviderPreferencesIgnore](../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"
] | -| `max_price` | [Optional[components.MaxPrice]](../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` | List[[components.ProviderPreferencesOnly](../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` | [Optional[components.ProviderOptions]](../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` | List[[components.ProviderPreferencesOrder](../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"
] | -| `preferred_max_latency` | [OptionalNullable[components.PreferredMaxLatency]](../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 | -| `preferred_min_throughput` | [OptionalNullable[components.PreferredMinThroughput]](../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` | List[[components.Quantization](../components/quantization.mdx)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | -| `require_parameters` | *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[components.ProviderPreferencesSort]](../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[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 +| `allow_fallbacks` | *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.
| | +| `data_collection` | [OptionalNullable[components.DataCollection]](../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 | +| `enforce_distillable_text` | *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` | List[[components.ProviderPreferencesIgnore](../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"
] | +| `max_price` | [Optional[components.MaxPrice]](../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` | List[[components.ProviderPreferencesOnly](../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` | [Optional[components.ProviderOptions]](../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` | List[[components.ProviderPreferencesOrder](../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"
] | +| `preferred_max_latency` | [OptionalNullable[components.PreferredMaxLatency]](../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 | +| `preferred_min_throughput` | [OptionalNullable[components.PreferredMinThroughput]](../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` | List[[components.Quantization](../components/quantization.mdx)] | ➖ | A list of quantization levels to filter the provider by. | | +| `require_parameters` | *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[components.ProviderPreferencesSort]](../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[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/components/providerresponse.mdx b/docs/components/providerresponse.mdx index dd376f095..526b30036 100644 --- a/docs/components/providerresponse.mdx +++ b/docs/components/providerresponse.mdx @@ -9,11 +9,11 @@ Details of a provider response for a generation attempt | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `endpoint_id` | *Optional[str]* | :heavy_minus_sign: | Internal endpoint identifier | ep_abc123 | -| `id` | *Optional[str]* | :heavy_minus_sign: | Upstream provider response identifier | chatcmpl-abc123 | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether the request used a bring-your-own-key | false | -| `latency` | *Optional[float]* | :heavy_minus_sign: | Response latency in milliseconds | 1200 | -| `model_permaslug` | *Optional[str]* | :heavy_minus_sign: | Canonical model slug | openai/gpt-4 | -| `provider_name` | [Optional[components.ProviderResponseProviderName]](../components/providerresponseprovidername.mdx) | :heavy_minus_sign: | Name of the provider | OpenAI | -| `routed_service_tier` | [Optional[components.RoutedServiceTier]](../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` | *Nullable[int]* | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file +| `endpoint_id` | *Optional[str]* | ➖ | Internal endpoint identifier | ep_abc123 | +| `id` | *Optional[str]* | ➖ | Upstream provider response identifier | chatcmpl-abc123 | +| `is_byok` | *Optional[bool]* | ➖ | Whether the request used a bring-your-own-key | false | +| `latency` | *Optional[float]* | ➖ | Response latency in milliseconds | 1200 | +| `model_permaslug` | *Optional[str]* | ➖ | Canonical model slug | openai/gpt-4 | +| `provider_name` | [Optional[components.ProviderResponseProviderName]](../components/providerresponseprovidername.mdx) | ➖ | Name of the provider | OpenAI | +| `routed_service_tier` | [Optional[components.RoutedServiceTier]](../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` | *Nullable[int]* | ✅ | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/docs/components/providersortconfig.mdx b/docs/components/providersortconfig.mdx index 5aa8e90a6..d9306e318 100644 --- a/docs/components/providersortconfig.mdx +++ b/docs/components/providersortconfig.mdx @@ -9,5 +9,5 @@ The provider sorting strategy (price, throughput, latency) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `by` | [OptionalNullable[components.By]](../components/by.mdx) | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | -| `partition` | [OptionalNullable[components.Partition]](../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[components.By]](../components/by.mdx) | ➖ | The provider sorting strategy (price, throughput, latency) | price | +| `partition` | [OptionalNullable[components.Partition]](../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/components/provisioninternresponse.mdx b/docs/components/provisioninternresponse.mdx index be1e5af93..18f80f088 100644 --- a/docs/components/provisioninternresponse.mdx +++ b/docs/components/provisioninternresponse.mdx @@ -6,4 +6,4 @@ title: "ProvisionInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `provisioning` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `provisioning` | *Literal[True]* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/publicendpoint.mdx b/docs/components/publicendpoint.mdx index f4828c024..3a1c6da93 100644 --- a/docs/components/publicendpoint.mdx +++ b/docs/components/publicendpoint.mdx @@ -9,27 +9,27 @@ Information about a specific model endpoint | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context_length` | *int* | :heavy_check_mark: | N/A | | -| `latency_last_30m` | [Nullable[components.PercentileStats]](../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
} | -| `max_completion_tokens` | *Nullable[int]* | :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. | | -| `max_prompt_tokens` | *Nullable[int]* | :heavy_check_mark: | N/A | | -| `model_id` | *str* | :heavy_check_mark: | The unique identifier for the model (permaslug) | openai/gpt-4 | -| `model_name` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `native_tools` | Dict[str, [components.NativeTools](../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"
}
} | -| `perf_last_30m_by_workload` | [Optional[components.PerfLast30mByWorkload]](../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](../components/pricing.mdx) | :heavy_check_mark: | N/A | | -| `provider_name` | [components.ProviderName](../components/providername.mdx) | :heavy_check_mark: | N/A | OpenAI | -| `quantization` | [Nullable[components.Quantization]](../components/quantization.mdx) | :heavy_check_mark: | N/A | fp16 | -| `status` | [Optional[components.EndpointStatus]](../components/endpointstatus.mdx) | :heavy_minus_sign: | N/A | 0 | -| `supported_parameters` | List[[components.Parameter](../components/parameter.mdx)] | :heavy_check_mark: | N/A | | -| `supports_image_reference` | *Optional[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. | | -| `supports_implicit_caching` | *bool* | :heavy_check_mark: | N/A | | -| `supports_multiple_audio_references` | *Optional[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. | | -| `supports_tool_choice` | [components.ToolChoiceSupport](../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
} | -| `supports_voice_cloning` | *Optional[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` | *str* | :heavy_check_mark: | N/A | | -| `throughput_last_30m` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `uptime_last_1d` | *Nullable[float]* | :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. | | -| `uptime_last_30m` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `uptime_last_5m` | *Nullable[float]* | :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 +| `context_length` | *int* | ✅ | N/A | | +| `latency_last_30m` | [Nullable[components.PercentileStats]](../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
} | +| `max_completion_tokens` | *Nullable[int]* | ✅ | 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. | | +| `max_prompt_tokens` | *Nullable[int]* | ✅ | N/A | | +| `model_id` | *str* | ✅ | The unique identifier for the model (permaslug) | openai/gpt-4 | +| `model_name` | *str* | ✅ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `native_tools` | Dict[str, [components.NativeTools](../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"
}
} | +| `perf_last_30m_by_workload` | [Optional[components.PerfLast30mByWorkload]](../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](../components/pricing.mdx) | ✅ | N/A | | +| `provider_name` | [components.ProviderName](../components/providername.mdx) | ✅ | N/A | OpenAI | +| `quantization` | [Nullable[components.Quantization]](../components/quantization.mdx) | ✅ | N/A | fp16 | +| `status` | [Optional[components.EndpointStatus]](../components/endpointstatus.mdx) | ➖ | N/A | 0 | +| `supported_parameters` | List[[components.Parameter](../components/parameter.mdx)] | ✅ | N/A | | +| `supports_image_reference` | *Optional[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. | | +| `supports_implicit_caching` | *bool* | ✅ | N/A | | +| `supports_multiple_audio_references` | *Optional[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. | | +| `supports_tool_choice` | [components.ToolChoiceSupport](../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
} | +| `supports_voice_cloning` | *Optional[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` | *str* | ✅ | N/A | | +| `throughput_last_30m` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `uptime_last_1d` | *Nullable[float]* | ✅ | 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. | | +| `uptime_last_30m` | *Nullable[float]* | ✅ | N/A | | +| `uptime_last_5m` | *Nullable[float]* | ✅ | 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/components/publicpricing.mdx b/docs/components/publicpricing.mdx index 894ca95c0..36b7ef583 100644 --- a/docs/components/publicpricing.mdx +++ b/docs/components/publicpricing.mdx @@ -9,19 +9,19 @@ Pricing information for the model | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `audio` | *Optional[str]* | :heavy_minus_sign: | Price in USD per audio input token | -| `audio_output` | *Optional[str]* | :heavy_minus_sign: | Price in USD per audio output token | -| `completion` | *str* | :heavy_check_mark: | Price in USD per token for completion (output) generation | -| `discount` | *Optional[float]* | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `image` | *Optional[str]* | :heavy_minus_sign: | Price in USD per input image | -| `image_output` | *Optional[str]* | :heavy_minus_sign: | Price in USD per output image | -| `image_token` | *Optional[str]* | :heavy_minus_sign: | Price in USD per image token | -| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | Price in USD per cached audio input token | -| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | Price in USD per cached input token (read) | -| `input_cache_write` | *Optional[str]* | :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. | -| `input_cache_write_1h` | *Optional[str]* | :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. | -| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | Price in USD per internal reasoning token | -| `overrides` | List[[components.PricingOverride](../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` | *str* | :heavy_check_mark: | Price in USD per token for prompt (input) processing | -| `request` | *Optional[str]* | :heavy_minus_sign: | Price in USD per request | -| `web_search` | *Optional[str]* | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file +| `audio` | *Optional[str]* | ➖ | Price in USD per audio input token | +| `audio_output` | *Optional[str]* | ➖ | Price in USD per audio output token | +| `completion` | *str* | ✅ | Price in USD per token for completion (output) generation | +| `discount` | *Optional[float]* | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `image` | *Optional[str]* | ➖ | Price in USD per input image | +| `image_output` | *Optional[str]* | ➖ | Price in USD per output image | +| `image_token` | *Optional[str]* | ➖ | Price in USD per image token | +| `input_audio_cache` | *Optional[str]* | ➖ | Price in USD per cached audio input token | +| `input_cache_read` | *Optional[str]* | ➖ | Price in USD per cached input token (read) | +| `input_cache_write` | *Optional[str]* | ➖ | 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. | +| `input_cache_write_1h` | *Optional[str]* | ➖ | 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. | +| `internal_reasoning` | *Optional[str]* | ➖ | Price in USD per internal reasoning token | +| `overrides` | List[[components.PricingOverride](../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` | *str* | ✅ | Price in USD per token for prompt (input) processing | +| `request` | *Optional[str]* | ➖ | Price in USD per request | +| `web_search` | *Optional[str]* | ➖ | Price in USD per web search | \ No newline at end of file diff --git a/docs/components/rangecapability.mdx b/docs/components/rangecapability.mdx index 34425c50e..a5ab7c9b6 100644 --- a/docs/components/rangecapability.mdx +++ b/docs/components/rangecapability.mdx @@ -9,6 +9,6 @@ A parameter that accepts any value within an inclusive numeric range. | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `max` | *float* | :heavy_check_mark: | N/A | -| `min` | *float* | :heavy_check_mark: | N/A | -| `type` | [components.RangeCapabilityType](../components/rangecapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `max` | *float* | ✅ | N/A | +| `min` | *float* | ✅ | N/A | +| `type` | [components.RangeCapabilityType](../components/rangecapabilitytype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/rankingoptions.mdx b/docs/components/rankingoptions.mdx index 2f3d38a04..1f2d64ea6 100644 --- a/docs/components/rankingoptions.mdx +++ b/docs/components/rankingoptions.mdx @@ -6,5 +6,5 @@ title: "RankingOptions" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `ranker` | [Optional[components.Ranker]](../components/ranker.mdx) | :heavy_minus_sign: | N/A | -| `score_threshold` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ranker` | [Optional[components.Ranker]](../components/ranker.mdx) | ➖ | N/A | +| `score_threshold` | *Optional[float]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/rankingsdailyitem.mdx b/docs/components/rankingsdailyitem.mdx index b2e760295..370e0f663 100644 --- a/docs/components/rankingsdailyitem.mdx +++ b/docs/components/rankingsdailyitem.mdx @@ -6,6 +6,6 @@ title: "RankingsDailyItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `date_` | *str* | :heavy_check_mark: | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | -| `model_permaslug` | *str* | :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 | -| `total_tokens` | *str* | :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_` | *str* | ✅ | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | +| `model_permaslug` | *str* | ✅ | 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 | +| `total_tokens` | *str* | ✅ | 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/components/rankingsdailymeta.mdx b/docs/components/rankingsdailymeta.mdx index de87408be..e690835d0 100644 --- a/docs/components/rankingsdailymeta.mdx +++ b/docs/components/rankingsdailymeta.mdx @@ -6,7 +6,7 @@ title: "RankingsDailyMeta" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `as_of` | *str* | :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 | -| `end_date` | *str* | :heavy_check_mark: | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | -| `start_date` | *str* | :heavy_check_mark: | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | -| `version` | [components.RankingsDailyMetaVersion](../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 +| `as_of` | *str* | ✅ | 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 | +| `end_date` | *str* | ✅ | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | +| `start_date` | *str* | ✅ | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | +| `version` | [components.RankingsDailyMetaVersion](../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/components/rankingsdailyresponse.mdx b/docs/components/rankingsdailyresponse.mdx index ff97dff4b..17a75ac0a 100644 --- a/docs/components/rankingsdailyresponse.mdx +++ b/docs/components/rankingsdailyresponse.mdx @@ -6,5 +6,5 @@ title: "RankingsDailyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.RankingsDailyItem](../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](../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` | List[[components.RankingsDailyItem](../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](../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/components/reasoningconfig.mdx b/docs/components/reasoningconfig.mdx index 12bc5225a..a91acea9b 100644 --- a/docs/components/reasoningconfig.mdx +++ b/docs/components/reasoningconfig.mdx @@ -6,9 +6,9 @@ title: "ReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context` | [OptionalNullable[components.ReasoningContext]](../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[components.ReasoningEffort]](../components/reasoningeffort.mdx) | :heavy_minus_sign: | N/A | medium | -| `mode` | [OptionalNullable[components.ReasoningMode]](../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[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.mdx) | :heavy_minus_sign: | N/A | auto | -| `enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `context` | [OptionalNullable[components.ReasoningContext]](../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[components.ReasoningEffort]](../components/reasoningeffort.mdx) | ➖ | N/A | medium | +| `mode` | [OptionalNullable[components.ReasoningMode]](../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[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.mdx) | ➖ | N/A | auto | +| `enabled` | *OptionalNullable[bool]* | ➖ | N/A | | +| `max_tokens` | *OptionalNullable[int]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdeltaevent.mdx b/docs/components/reasoningdeltaevent.mdx index 2c29c423c..dc086e31d 100644 --- a/docs/components/reasoningdeltaevent.mdx +++ b/docs/components/reasoningdeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning text delta is streamed | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningDeltaEventType](../components/reasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content_index` | *int* | ✅ | N/A | +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.ReasoningDeltaEventType](../components/reasoningdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/reasoningdetailencrypted.mdx b/docs/components/reasoningdetailencrypted.mdx index af4cce611..01662d419 100644 --- a/docs/components/reasoningdetailencrypted.mdx +++ b/docs/components/reasoningdetailencrypted.mdx @@ -9,8 +9,8 @@ Reasoning detail encrypted schema | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `type` | [components.ReasoningDetailEncryptedType](../components/reasoningdetailencryptedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `data` | *str* | ✅ | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `index` | *Optional[int]* | ➖ | N/A | | +| `type` | [components.ReasoningDetailEncryptedType](../components/reasoningdetailencryptedtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdetailservertoolcall.mdx b/docs/components/reasoningdetailservertoolcall.mdx index 78f316a13..a66597535 100644 --- a/docs/components/reasoningdetailservertoolcall.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `result` | *str* | :heavy_check_mark: | N/A | | -| `tool_call_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `tool_name` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.ReasoningDetailServerToolCallType](../components/reasoningdetailservertoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *str* | ✅ | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `index` | *Optional[int]* | ➖ | N/A | | +| `result` | *str* | ✅ | N/A | | +| `tool_call_id` | *OptionalNullable[str]* | ➖ | N/A | | +| `tool_name` | *str* | ✅ | N/A | | +| `type` | [components.ReasoningDetailServerToolCallType](../components/reasoningdetailservertoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdetailsummary.mdx b/docs/components/reasoningdetailsummary.mdx index f0ad47f1d..2f6342726 100644 --- a/docs/components/reasoningdetailsummary.mdx +++ b/docs/components/reasoningdetailsummary.mdx @@ -9,8 +9,8 @@ Reasoning detail summary schema | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `summary` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.ReasoningDetailSummaryType](../components/reasoningdetailsummarytype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `index` | *Optional[int]* | ➖ | N/A | | +| `summary` | *str* | ✅ | N/A | | +| `type` | [components.ReasoningDetailSummaryType](../components/reasoningdetailsummarytype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdetailtext.mdx b/docs/components/reasoningdetailtext.mdx index 54a6696ff..df5a9e85c 100644 --- a/docs/components/reasoningdetailtext.mdx +++ b/docs/components/reasoningdetailtext.mdx @@ -9,9 +9,9 @@ Reasoning detail text schema | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `text` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.ReasoningDetailTextType](../components/reasoningdetailtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `index` | *Optional[int]* | ➖ | N/A | | +| `signature` | *OptionalNullable[str]* | ➖ | N/A | | +| `text` | *OptionalNullable[str]* | ➖ | N/A | | +| `type` | [components.ReasoningDetailTextType](../components/reasoningdetailtexttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningdoneevent.mdx b/docs/components/reasoningdoneevent.mdx index 6068c9df0..a3f67ab02 100644 --- a/docs/components/reasoningdoneevent.mdx +++ b/docs/components/reasoningdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning text streaming is complete | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningDoneEventType](../components/reasoningdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content_index` | *int* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `text` | *str* | ✅ | N/A | +| `type` | [components.ReasoningDoneEventType](../components/reasoningdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/reasoningitem.mdx b/docs/components/reasoningitem.mdx index 1afe61896..a8d6e8faa 100644 --- a/docs/components/reasoningitem.mdx +++ b/docs/components/reasoningitem.mdx @@ -9,11 +9,11 @@ Reasoning output item with signature and format extensions | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [Optional[components.ReasoningItemStatusUnion]](../components/reasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | :heavy_check_mark: | N/A | | -| `type` | [components.ReasoningItemType](../components/reasoningitemtype.mdx) | :heavy_check_mark: | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.mdx)] | ➖ | N/A | | +| `encrypted_content` | *OptionalNullable[str]* | ➖ | N/A | | +| `id` | *str* | ✅ | N/A | | +| `status` | [Optional[components.ReasoningItemStatusUnion]](../components/reasoningitemstatusunion.mdx) | ➖ | N/A | | +| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.mdx)] | ✅ | N/A | | +| `type` | [components.ReasoningItemType](../components/reasoningitemtype.mdx) | ✅ | N/A | | +| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.mdx) | ➖ | N/A | unknown | +| `signature` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningsummarypartaddedevent.mdx b/docs/components/reasoningsummarypartaddedevent.mdx index 277f61694..be5cc403b 100644 --- a/docs/components/reasoningsummarypartaddedevent.mdx +++ b/docs/components/reasoningsummarypartaddedevent.mdx @@ -9,9 +9,9 @@ Event emitted when a reasoning summary part is added | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `part` | [components.ReasoningSummaryText](../components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `summary_index` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.ReasoningSummaryPartAddedEventType](../components/reasoningsummarypartaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | | +| `output_index` | *int* | ✅ | N/A | | +| `part` | [components.ReasoningSummaryText](../components/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `sequence_number` | *int* | ✅ | N/A | | +| `summary_index` | *int* | ✅ | N/A | | +| `type` | [components.ReasoningSummaryPartAddedEventType](../components/reasoningsummarypartaddedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningsummarypartdoneevent.mdx b/docs/components/reasoningsummarypartdoneevent.mdx index f648a1e1b..507d13031 100644 --- a/docs/components/reasoningsummarypartdoneevent.mdx +++ b/docs/components/reasoningsummarypartdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when a reasoning summary part is complete | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `part` | [components.ReasoningSummaryText](../components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `summary_index` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.ReasoningSummaryPartDoneEventType](../components/reasoningsummarypartdoneeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | | +| `output_index` | *int* | ✅ | N/A | | +| `part` | [components.ReasoningSummaryText](../components/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `sequence_number` | *int* | ✅ | N/A | | +| `summary_index` | *int* | ✅ | N/A | | +| `type` | [components.ReasoningSummaryPartDoneEventType](../components/reasoningsummarypartdoneeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/reasoningsummarytext.mdx b/docs/components/reasoningsummarytext.mdx index 0a97676ea..a64a277d9 100644 --- a/docs/components/reasoningsummarytext.mdx +++ b/docs/components/reasoningsummarytext.mdx @@ -6,5 +6,5 @@ title: "ReasoningSummaryText" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningSummaryTextType](../components/reasoningsummarytexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *str* | ✅ | N/A | +| `type` | [components.ReasoningSummaryTextType](../components/reasoningsummarytexttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/reasoningsummarytextdeltaevent.mdx b/docs/components/reasoningsummarytextdeltaevent.mdx index 204b30efe..94b864749 100644 --- a/docs/components/reasoningsummarytextdeltaevent.mdx +++ b/docs/components/reasoningsummarytextdeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning summary text delta is streamed | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `summary_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningSummaryTextDeltaEventType](../components/reasoningsummarytextdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `summary_index` | *int* | ✅ | N/A | +| `type` | [components.ReasoningSummaryTextDeltaEventType](../components/reasoningsummarytextdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/reasoningsummarytextdoneevent.mdx b/docs/components/reasoningsummarytextdoneevent.mdx index 540a20cea..f7c46fc58 100644 --- a/docs/components/reasoningsummarytextdoneevent.mdx +++ b/docs/components/reasoningsummarytextdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning summary text streaming is complete | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `summary_index` | *int* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningSummaryTextDoneEventType](../components/reasoningsummarytextdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `summary_index` | *int* | ✅ | N/A | +| `text` | *str* | ✅ | N/A | +| `type` | [components.ReasoningSummaryTextDoneEventType](../components/reasoningsummarytextdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/reasoningtextcontent.mdx b/docs/components/reasoningtextcontent.mdx index 6fbaeeed4..215b59360 100644 --- a/docs/components/reasoningtextcontent.mdx +++ b/docs/components/reasoningtextcontent.mdx @@ -6,5 +6,5 @@ title: "ReasoningTextContent" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningTextContentType](../components/reasoningtextcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *str* | ✅ | N/A | +| `type` | [components.ReasoningTextContentType](../components/reasoningtextcontenttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/refusal.mdx b/docs/components/refusal.mdx index 2d1c89c34..1d5fb3a2d 100644 --- a/docs/components/refusal.mdx +++ b/docs/components/refusal.mdx @@ -6,7 +6,7 @@ title: "Refusal" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `top_logprobs` | List[[components.RefusalTopLogprob](../components/refusaltoplogprob.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | ✅ | N/A | +| `logprob` | *float* | ✅ | N/A | +| `token` | *str* | ✅ | N/A | +| `top_logprobs` | List[[components.RefusalTopLogprob](../components/refusaltoplogprob.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/refusaldeltaevent.mdx b/docs/components/refusaldeltaevent.mdx index 046947a1c..ece0d48dd 100644 --- a/docs/components/refusaldeltaevent.mdx +++ b/docs/components/refusaldeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when a refusal delta is streamed | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.RefusalDeltaEventType](../components/refusaldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content_index` | *int* | ✅ | N/A | +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.RefusalDeltaEventType](../components/refusaldeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/refusaldoneevent.mdx b/docs/components/refusaldoneevent.mdx index ccc2709f3..a5adafc61 100644 --- a/docs/components/refusaldoneevent.mdx +++ b/docs/components/refusaldoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when refusal streaming is complete | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `refusal` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.RefusalDoneEventType](../components/refusaldoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content_index` | *int* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `refusal` | *str* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.RefusalDoneEventType](../components/refusaldoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/refusaltoplogprob.mdx b/docs/components/refusaltoplogprob.mdx index fa0f7cb0a..b78b45e88 100644 --- a/docs/components/refusaltoplogprob.mdx +++ b/docs/components/refusaltoplogprob.mdx @@ -6,6 +6,6 @@ title: "RefusalTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | ✅ | N/A | +| `logprob` | *float* | ✅ | N/A | +| `token` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/request.mdx b/docs/components/request.mdx index 3ae4bc94d..ffb4b0ee7 100644 --- a/docs/components/request.mdx +++ b/docs/components/request.mdx @@ -6,5 +6,5 @@ title: "Request" | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `body` | Dict[str, *Any*] | :heavy_check_mark: | Request payload for the batch `endpoint`. | -| `custom_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `body` | Dict[str, *Any*] | ✅ | Request payload for the batch `endpoint`. | +| `custom_id` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/requesttimeoutresponseerrordata.mdx b/docs/components/requesttimeoutresponseerrordata.mdx index 711c93c9a..410f61fae 100644 --- a/docs/components/requesttimeoutresponseerrordata.mdx +++ b/docs/components/requesttimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for RequestTimeoutResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/requireapproval.mdx b/docs/components/requireapproval.mdx index 79583bfa0..24f6adc5c 100644 --- a/docs/components/requireapproval.mdx +++ b/docs/components/requireapproval.mdx @@ -6,5 +6,5 @@ title: "RequireApproval" | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `always` | [Optional[components.Always]](../components/always.mdx) | :heavy_minus_sign: | N/A | -| `never` | [Optional[components.Never]](../components/never.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `always` | [Optional[components.Always]](../components/always.mdx) | ➖ | N/A | +| `never` | [Optional[components.Never]](../components/never.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/rerank.mdx b/docs/components/rerank.mdx index 171e9c32d..36d364110 100644 --- a/docs/components/rerank.mdx +++ b/docs/components/rerank.mdx @@ -6,6 +6,6 @@ title: "Rerank" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../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` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/responsehealingplugin.mdx b/docs/components/responsehealingplugin.mdx index 8b89cfa96..8e7bcf3f4 100644 --- a/docs/components/responsehealingplugin.mdx +++ b/docs/components/responsehealingplugin.mdx @@ -6,5 +6,5 @@ title: "ResponseHealingPlugin" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | -| `id` | [components.ResponseHealingPluginID](../components/responsehealingpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `enabled` | *Optional[bool]* | ➖ | Set to false to disable the response-healing plugin for this request. Defaults to true. | +| `id` | [components.ResponseHealingPluginID](../components/responsehealingpluginid.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/responseoutputtext.mdx b/docs/components/responseoutputtext.mdx index a6879aa83..15fdc58b2 100644 --- a/docs/components/responseoutputtext.mdx +++ b/docs/components/responseoutputtext.mdx @@ -6,7 +6,7 @@ title: "ResponseOutputText" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `annotations` | List[[components.OpenAIResponsesAnnotation](../components/openairesponsesannotation.mdx)] | :heavy_minus_sign: | N/A | -| `logprobs` | List[[components.Logprob](../components/logprob.mdx)] | :heavy_minus_sign: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ResponseOutputTextType](../components/responseoutputtexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `annotations` | List[[components.OpenAIResponsesAnnotation](../components/openairesponsesannotation.mdx)] | ➖ | N/A | +| `logprobs` | List[[components.Logprob](../components/logprob.mdx)] | ➖ | N/A | +| `text` | *str* | ✅ | N/A | +| `type` | [components.ResponseOutputTextType](../components/responseoutputtexttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/responseoutputtexttoplogprob.mdx b/docs/components/responseoutputtexttoplogprob.mdx index b085f1887..05261c077 100644 --- a/docs/components/responseoutputtexttoplogprob.mdx +++ b/docs/components/responseoutputtexttoplogprob.mdx @@ -6,6 +6,6 @@ title: "ResponseOutputTextTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | ✅ | N/A | +| `logprob` | *float* | ✅ | N/A | +| `token` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/responsesrequest.mdx b/docs/components/responsesrequest.mdx index d048ec2db..0cc9ad025 100644 --- a/docs/components/responsesrequest.mdx +++ b/docs/components/responsesrequest.mdx @@ -9,43 +9,43 @@ Request schema for Responses endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.ChatDebugOptions]](../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](../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` | List[[components.ResponseIncludesEnum](../components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | -| `input` | [Optional[components.InputsUnion]](../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[str]* | :heavy_minus_sign: | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :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` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](../components/outputmodalityenum.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](../components/responsesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../components/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | :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 | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../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. | | -| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[Literal[False]]* | :heavy_minus_sign: | N/A | | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](../components/responsesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](../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[components.OpenAIResponsesTruncation]](../components/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | -| `user` | *Optional[str]* | :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[bool]* | ➖ | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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` | [Optional[components.ChatDebugOptions]](../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | | +| `image_config` | Dict[str, [components.ImageConfig](../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` | List[[components.ResponseIncludesEnum](../components/responseincludesenum.mdx)] | ➖ | N/A | | +| `input` | [Optional[components.InputsUnion]](../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[str]* | ➖ | N/A | | +| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | ➖ | 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` | Dict[str, *str*] | ➖ | 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` | List[[components.OutputModalityEnum](../components/outputmodalityenum.mdx)] | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `model` | *Optional[str]* | ➖ | N/A | | +| `models` | List[*str*] | ➖ | N/A | | +| `parallel_tool_calls` | *OptionalNullable[bool]* | ➖ | N/A | | +| `plugins` | List[[components.ResponsesRequestPlugin](../components/responsesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | | +| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../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[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../components/reasoningconfig.mdx) | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | ➖ | 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 | +| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../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. | | +| `session_id` | *Optional[str]* | ➖ | 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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../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` | *Optional[Literal[False]]* | ➖ | N/A | | +| `stream` | *Optional[bool]* | ➖ | N/A | | +| `temperature` | *OptionalNullable[float]* | ➖ | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | +| `tools` | List[[components.ResponsesRequestToolUnion](../components/responsesrequesttoolunion.mdx)] | ➖ | N/A | | +| `top_k` | *Optional[int]* | ➖ | N/A | | +| `top_logprobs` | *OptionalNullable[int]* | ➖ | N/A | | +| `top_p` | *OptionalNullable[float]* | ➖ | N/A | | +| `trace` | [Optional[components.TraceConfig]](../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[components.OpenAIResponsesTruncation]](../components/openairesponsestruncation.mdx) | ➖ | N/A | auto | +| `user` | *Optional[str]* | ➖ | 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/components/responsesrequesttoolfunction.mdx b/docs/components/responsesrequesttoolfunction.mdx index 4eeb6ce10..026cd6904 100644 --- a/docs/components/responsesrequesttoolfunction.mdx +++ b/docs/components/responsesrequesttoolfunction.mdx @@ -9,12 +9,12 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `parameters` | Dict[str, *Any*] | :heavy_check_mark: | N/A | | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `type` | [components.ResponsesRequestType](../components/responsesrequesttype.mdx) | :heavy_check_mark: | N/A | | -| `allowed_callers` | List[[components.ResponsesRequestAllowedCaller](../components/responsesrequestallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | -| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `description` | *OptionalNullable[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `parameters` | Dict[str, *Any*] | ✅ | N/A | | +| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | +| `type` | [components.ResponsesRequestType](../components/responsesrequesttype.mdx) | ✅ | N/A | | +| `allowed_callers` | List[[components.ResponsesRequestAllowedCaller](../components/responsesrequestallowedcaller.mdx)] | ➖ | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | +| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/responsesstreamingresponse.mdx b/docs/components/responsesstreamingresponse.mdx index 2d97adfb5..d05862638 100644 --- a/docs/components/responsesstreamingresponse.mdx +++ b/docs/components/responsesstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ResponsesStreamingResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.StreamEvents](../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](../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/components/result.mdx b/docs/components/result.mdx index 77ee48483..f587c66d3 100644 --- a/docs/components/result.mdx +++ b/docs/components/result.mdx @@ -6,7 +6,7 @@ title: "Result" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `custom_id` | *str* | :heavy_check_mark: | N/A | -| `error` | [Nullable[components.ResultError]](../components/resulterror.mdx) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `response` | [Nullable[components.BatchObjectResponse]](../components/batchobjectresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `custom_id` | *str* | ✅ | N/A | +| `error` | [Nullable[components.ResultError]](../components/resulterror.mdx) | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `response` | [Nullable[components.BatchObjectResponse]](../components/batchobjectresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/resulterror.mdx b/docs/components/resulterror.mdx index 2609a9af0..403fb0b79 100644 --- a/docs/components/resulterror.mdx +++ b/docs/components/resulterror.mdx @@ -6,7 +6,7 @@ title: "ResultError" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `error_type` | [Optional[components.APIErrorType]](../components/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `message` | *str* | :heavy_check_mark: | N/A | | -| `param` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `type` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `error_type` | [Optional[components.APIErrorType]](../components/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `message` | *str* | ✅ | N/A | | +| `param` | *Nullable[str]* | ✅ | N/A | | +| `type` | *str* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/routerattempt.mdx b/docs/components/routerattempt.mdx index a082fd19f..a30441233 100644 --- a/docs/components/routerattempt.mdx +++ b/docs/components/routerattempt.mdx @@ -6,6 +6,6 @@ title: "RouterAttempt" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | :heavy_check_mark: | N/A | -| `provider` | *str* | :heavy_check_mark: | N/A | -| `status` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `model` | *str* | ✅ | N/A | +| `provider` | *str* | ✅ | N/A | +| `status` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/routerparams.mdx b/docs/components/routerparams.mdx index 5354eeb9d..1445db222 100644 --- a/docs/components/routerparams.mdx +++ b/docs/components/routerparams.mdx @@ -6,7 +6,7 @@ title: "RouterParams" | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `quality_floor` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `throughput_floor` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `version_group` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file +| `quality_floor` | *Optional[float]* | ➖ | N/A | | +| `throughput_floor` | *Optional[float]* | ➖ | N/A | | +| `version_group` | *Optional[str]* | ➖ | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file diff --git a/docs/components/rule.mdx b/docs/components/rule.mdx index 14a9f7136..bb99c7c7e 100644 --- a/docs/components/rule.mdx +++ b/docs/components/rule.mdx @@ -6,6 +6,6 @@ title: "Rule" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `field` | [components.FieldT](../components/fieldt.mdx) | :heavy_check_mark: | N/A | -| `operator` | [components.Operator](../components/operator.mdx) | :heavy_check_mark: | N/A | -| `value` | [Optional[components.ObservabilityFilterRuleGroupValue]](../components/observabilityfilterrulegroupvalue.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `field` | [components.FieldT](../components/fieldt.mdx) | ✅ | N/A | +| `operator` | [components.Operator](../components/operator.mdx) | ✅ | N/A | +| `value` | [Optional[components.ObservabilityFilterRuleGroupValue]](../components/observabilityfilterrulegroupvalue.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/scimgroup.mdx b/docs/components/scimgroup.mdx index 98a3dfc33..656c386c2 100644 --- a/docs/components/scimgroup.mdx +++ b/docs/components/scimgroup.mdx @@ -6,9 +6,9 @@ title: "ScimGroup" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `display_name` | *str* | :heavy_check_mark: | N/A | -| `external_id` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `organization_id` | *str* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `created_at` | *str* | ✅ | N/A | +| `display_name` | *str* | ✅ | N/A | +| `external_id` | *Nullable[str]* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `organization_id` | *str* | ✅ | N/A | +| `updated_at` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/scimgroupmapping.mdx b/docs/components/scimgroupmapping.mdx index a1ee91fad..509ea63f2 100644 --- a/docs/components/scimgroupmapping.mdx +++ b/docs/components/scimgroupmapping.mdx @@ -6,10 +6,10 @@ title: "ScimGroupMapping" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `organization_id` | *str* | :heavy_check_mark: | N/A | -| `role` | [components.ScimGroupMappingRole](../components/scimgroupmappingrole.mdx) | :heavy_check_mark: | N/A | -| `scim_group_id` | *str* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `created_at` | *str* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `organization_id` | *str* | ✅ | N/A | +| `role` | [components.ScimGroupMappingRole](../components/scimgroupmappingrole.mdx) | ✅ | N/A | +| `scim_group_id` | *str* | ✅ | N/A | +| `updated_at` | *str* | ✅ | N/A | +| `workspace_id` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/scimsyncjob.mdx b/docs/components/scimsyncjob.mdx index 8d852b658..f6c7d4965 100644 --- a/docs/components/scimsyncjob.mdx +++ b/docs/components/scimsyncjob.mdx @@ -6,11 +6,11 @@ title: "ScimSyncJob" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | Time when the sync job was created. | -| `deleted_groups` | *Nullable[int]* | :heavy_check_mark: | Number of groups deleted, when the job completed successfully. | -| `error_message` | *Nullable[str]* | :heavy_check_mark: | Stable error message when the job failed. | -| `finished_at` | *Nullable[str]* | :heavy_check_mark: | Time when synchronization finished. | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the sync job. | -| `started_at` | *Nullable[str]* | :heavy_check_mark: | Time when synchronization started. | -| `status` | [components.ScimSyncJobStatus](../components/scimsyncjobstatus.mdx) | :heavy_check_mark: | Current status of the sync job: queued, running, succeeded, or failed. | -| `synced_groups` | *Nullable[int]* | :heavy_check_mark: | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file +| `created_at` | *str* | ✅ | Time when the sync job was created. | +| `deleted_groups` | *Nullable[int]* | ✅ | Number of groups deleted, when the job completed successfully. | +| `error_message` | *Nullable[str]* | ✅ | Stable error message when the job failed. | +| `finished_at` | *Nullable[str]* | ✅ | Time when synchronization finished. | +| `id` | *str* | ✅ | Unique identifier for the sync job. | +| `started_at` | *Nullable[str]* | ✅ | Time when synchronization started. | +| `status` | [components.ScimSyncJobStatus](../components/scimsyncjobstatus.mdx) | ✅ | Current status of the sync job: queued, running, succeeded, or failed. | +| `synced_groups` | *Nullable[int]* | ✅ | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file diff --git a/docs/components/searchmodelsservertoolconfig.mdx b/docs/components/searchmodelsservertoolconfig.mdx index fb2f7f7c5..dd714332e 100644 --- a/docs/components/searchmodelsservertoolconfig.mdx +++ b/docs/components/searchmodelsservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:experimental__search_models server tool | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file +| `max_results` | *Optional[int]* | ➖ | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file diff --git a/docs/components/searchmodelsservertoolopenrouter.mdx b/docs/components/searchmodelsservertoolopenrouter.mdx index e72c5e1cd..b7682c421 100644 --- a/docs/components/searchmodelsservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [components.SearchModelsServerToolOpenRouterType](../components/searchmodelsservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [components.SearchModelsServerToolOpenRouterType](../components/searchmodelsservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/security.mdx b/docs/components/security.mdx index 185abbfd5..e0340d2c2 100644 --- a/docs/components/security.mdx +++ b/docs/components/security.mdx @@ -6,4 +6,4 @@ title: "Security" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `api_key` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/servertool.mdx b/docs/components/servertool.mdx index 8f8f0d4e9..61fd5f7df 100644 --- a/docs/components/servertool.mdx +++ b/docs/components/servertool.mdx @@ -6,18 +6,18 @@ title: "ServerTool" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aliases` | List[[components.ServerToolInputName](../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 | | -| `default_engine` | *Nullable[str]* | :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 | -| `docs_url` | *str* | :heavy_check_mark: | N/A | | -| `engines` | List[[components.ServerToolEngine](../components/servertoolengine.mdx)] | :heavy_check_mark: | N/A | | -| `fallback_engine` | *Nullable[str]* | :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` | *str* | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `input_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `name` | *str* | :heavy_check_mark: | N/A | Web search | -| `native_support` | [components.ServerToolNativeSupport](../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
} | -| `output_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `parameters_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `status` | [components.ServerToolStatus](../components/servertoolstatus.mdx) | :heavy_check_mark: | N/A | active | -| `summary` | *str* | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | -| `supported_api_formats` | List[[components.ServerToolSupportedAPIFormat](../components/servertoolsupportedapiformat.mdx)] | :heavy_check_mark: | N/A | | -| `tool_description` | *str* | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file +| `aliases` | List[[components.ServerToolInputName](../components/servertoolinputname.mdx)] | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | +| `default_engine` | *Nullable[str]* | ✅ | 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 | +| `docs_url` | *str* | ✅ | N/A | | +| `engines` | List[[components.ServerToolEngine](../components/servertoolengine.mdx)] | ✅ | N/A | | +| `fallback_engine` | *Nullable[str]* | ✅ | 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` | *str* | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `input_schema` | Dict[str, *Any*] | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `name` | *str* | ✅ | N/A | Web search | +| `native_support` | [components.ServerToolNativeSupport](../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
} | +| `output_schema` | Dict[str, *Any*] | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `parameters_schema` | Dict[str, *Any*] | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `status` | [components.ServerToolStatus](../components/servertoolstatus.mdx) | ✅ | N/A | active | +| `summary` | *str* | ✅ | One sentence for cards and search results; never sent to a model | | +| `supported_api_formats` | List[[components.ServerToolSupportedAPIFormat](../components/servertoolsupportedapiformat.mdx)] | ✅ | N/A | | +| `tool_description` | *str* | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/components/servertooldetails.mdx b/docs/components/servertooldetails.mdx index 2ec8bf7ad..99b20b5d4 100644 --- a/docs/components/servertooldetails.mdx +++ b/docs/components/servertooldetails.mdx @@ -6,18 +6,18 @@ title: "ServerToolDetails" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aliases` | List[[components.ServerToolInputName](../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 | | -| `default_engine` | *Nullable[str]* | :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 | -| `docs_url` | *str* | :heavy_check_mark: | N/A | | -| `engines` | List[[components.ServerToolEngine](../components/servertoolengine.mdx)] | :heavy_check_mark: | N/A | | -| `fallback_engine` | *Nullable[str]* | :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` | *str* | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `input_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `name` | *str* | :heavy_check_mark: | N/A | Web search | -| `native_support` | [components.NativeSupport](../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
} | -| `output_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `parameters_schema` | Dict[str, *Any*] | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `status` | [components.ServerToolDetailsStatus](../components/servertooldetailsstatus.mdx) | :heavy_check_mark: | N/A | active | -| `summary` | *str* | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | -| `supported_api_formats` | List[[components.ServerToolDetailsSupportedAPIFormat](../components/servertooldetailssupportedapiformat.mdx)] | :heavy_check_mark: | N/A | | -| `tool_description` | *str* | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file +| `aliases` | List[[components.ServerToolInputName](../components/servertoolinputname.mdx)] | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | +| `default_engine` | *Nullable[str]* | ✅ | 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 | +| `docs_url` | *str* | ✅ | N/A | | +| `engines` | List[[components.ServerToolEngine](../components/servertoolengine.mdx)] | ✅ | N/A | | +| `fallback_engine` | *Nullable[str]* | ✅ | 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` | *str* | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `input_schema` | Dict[str, *Any*] | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `name` | *str* | ✅ | N/A | Web search | +| `native_support` | [components.NativeSupport](../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
} | +| `output_schema` | Dict[str, *Any*] | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `parameters_schema` | Dict[str, *Any*] | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `status` | [components.ServerToolDetailsStatus](../components/servertooldetailsstatus.mdx) | ✅ | N/A | active | +| `summary` | *str* | ✅ | One sentence for cards and search results; never sent to a model | | +| `supported_api_formats` | List[[components.ServerToolDetailsSupportedAPIFormat](../components/servertooldetailssupportedapiformat.mdx)] | ✅ | N/A | | +| `tool_description` | *str* | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/components/servertoolengine.mdx b/docs/components/servertoolengine.mdx index 65e059679..2bd6f9462 100644 --- a/docs/components/servertoolengine.mdx +++ b/docs/components/servertoolengine.mdx @@ -6,12 +6,12 @@ title: "ServerToolEngine" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok` | [components.BYOK](../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 | -| `data_regions` | List[[components.ServerToolEngineDataRegion](../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"
] | -| `default_mode` | *Nullable[str]* | :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 | -| `executed_by` | [components.ServerToolExecutedBy](../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` | *Nullable[str]* | :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` | *str* | :heavy_check_mark: | N/A | Exa | -| `pricing` | List[[components.ServerToolPrice](../components/servertoolprice.mdx)] | :heavy_check_mark: | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | -| `pricing_doc_url` | *Nullable[str]* | :heavy_check_mark: | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | -| `pricing_source` | [components.PricingSource](../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](../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 | +| `data_regions` | List[[components.ServerToolEngineDataRegion](../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"
] | +| `default_mode` | *Nullable[str]* | ✅ | 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 | +| `executed_by` | [components.ServerToolExecutedBy](../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` | *Nullable[str]* | ✅ | The `parameters.engine` value that selects this engine; null for the single engine of a tool without an engine parameter | exa | +| `name` | *str* | ✅ | N/A | Exa | +| `pricing` | List[[components.ServerToolPrice](../components/servertoolprice.mdx)] | ✅ | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | +| `pricing_doc_url` | *Nullable[str]* | ✅ | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | +| `pricing_source` | [components.PricingSource](../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/components/servertoolinputname.mdx b/docs/components/servertoolinputname.mdx index 24c135128..5a6ad4820 100644 --- a/docs/components/servertoolinputname.mdx +++ b/docs/components/servertoolinputname.mdx @@ -6,6 +6,6 @@ title: "ServerToolInputName" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_formats` | List[[components.ServerToolInputNameAPIFormat](../components/servertoolinputnameapiformat.mdx)] | :heavy_check_mark: | API formats that accept this spelling in `tools[].type` | | -| `output_names` | List[[components.ServerToolOutputName](../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` | *str* | :heavy_check_mark: | N/A | web_search_20250305 | \ No newline at end of file +| `api_formats` | List[[components.ServerToolInputNameAPIFormat](../components/servertoolinputnameapiformat.mdx)] | ✅ | API formats that accept this spelling in `tools[].type` | | +| `output_names` | List[[components.ServerToolOutputName](../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` | *str* | ✅ | N/A | web_search_20250305 | \ No newline at end of file diff --git a/docs/components/servertoolnativemodel.mdx b/docs/components/servertoolnativemodel.mdx index 5cd668a08..865246d37 100644 --- a/docs/components/servertoolnativemodel.mdx +++ b/docs/components/servertoolnativemodel.mdx @@ -6,5 +6,5 @@ title: "ServerToolNativeModel" | Field | Type | Required | Description | Example | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `providers` | List[*str*] | :heavy_check_mark: | N/A | [
"Anthropic",
"Google"
] | -| `slug` | *str* | :heavy_check_mark: | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file +| `providers` | List[*str*] | ✅ | N/A | [
"Anthropic",
"Google"
] | +| `slug` | *str* | ✅ | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file diff --git a/docs/components/servertoolnativesupport.mdx b/docs/components/servertoolnativesupport.mdx index b746ac366..b2fcadc8a 100644 --- a/docs/components/servertoolnativesupport.mdx +++ b/docs/components/servertoolnativesupport.mdx @@ -9,5 +9,5 @@ Endpoints whose provider runs this tool itself during inference. Zero for tools | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `endpoint_count` | *int* | :heavy_check_mark: | N/A | 18 | -| `model_count` | *int* | :heavy_check_mark: | N/A | 12 | \ No newline at end of file +| `endpoint_count` | *int* | ✅ | N/A | 18 | +| `model_count` | *int* | ✅ | N/A | 12 | \ No newline at end of file diff --git a/docs/components/servertooloutputname.mdx b/docs/components/servertooloutputname.mdx index 1d29864ad..dec6dd515 100644 --- a/docs/components/servertooloutputname.mdx +++ b/docs/components/servertooloutputname.mdx @@ -6,6 +6,6 @@ title: "ServerToolOutputName" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `api_format` | [components.ServerToolOutputNameAPIFormat](../components/servertooloutputnameapiformat.mdx) | :heavy_check_mark: | N/A | | -| `name` | *Optional[str]* | :heavy_minus_sign: | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | -| `type` | *str* | :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 +| `api_format` | [components.ServerToolOutputNameAPIFormat](../components/servertooloutputnameapiformat.mdx) | ✅ | N/A | | +| `name` | *Optional[str]* | ➖ | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | +| `type` | *str* | ✅ | 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/components/servertoolprice.mdx b/docs/components/servertoolprice.mdx index 78fe83c07..e77bceeb5 100644 --- a/docs/components/servertoolprice.mdx +++ b/docs/components/servertoolprice.mdx @@ -6,7 +6,7 @@ title: "ServerToolPrice" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `max_units_per_call` | *int* | :heavy_check_mark: | N/A | | -| `mode` | *Nullable[str]* | :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` | *str* | :heavy_check_mark: | USD per unit, as a decimal string | 0.007 | -| `unit` | *str* | :heavy_check_mark: | N/A | request | \ No newline at end of file +| `max_units_per_call` | *int* | ✅ | N/A | | +| `mode` | *Nullable[str]* | ✅ | 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` | *str* | ✅ | USD per unit, as a decimal string | 0.007 | +| `unit` | *str* | ✅ | N/A | request | \ No newline at end of file diff --git a/docs/components/servertoolusedetails.mdx b/docs/components/servertoolusedetails.mdx index de0d677d4..a25d35f96 100644 --- a/docs/components/servertoolusedetails.mdx +++ b/docs/components/servertoolusedetails.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `tool_calls_executed` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `tool_calls_requested` | *OptionalNullable[int]* | :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. | -| `web_search_requests` | *OptionalNullable[int]* | :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 +| `tool_calls_executed` | *OptionalNullable[int]* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `tool_calls_requested` | *OptionalNullable[int]* | ➖ | 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. | +| `web_search_requests` | *OptionalNullable[int]* | ➖ | 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/components/serviceunavailableresponseerrordata.mdx b/docs/components/serviceunavailableresponseerrordata.mdx index e4da707cb..79cfeeffc 100644 --- a/docs/components/serviceunavailableresponseerrordata.mdx +++ b/docs/components/serviceunavailableresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ServiceUnavailableResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/sessioncostitem.mdx b/docs/components/sessioncostitem.mdx index 6bab396f0..c329a3f7f 100644 --- a/docs/components/sessioncostitem.mdx +++ b/docs/components/sessioncostitem.mdx @@ -6,8 +6,8 @@ title: "SessionCostItem" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `app_name` | *str* | :heavy_check_mark: | Published harness display label. | Hermes Agent | -| `app_slug` | *str* | :heavy_check_mark: | Stable public slug of the harness. | hermes-agent | -| `median_session_cost_usd` | *float* | :heavy_check_mark: | Median USD spend per sampled session. | 1.74 | -| `model_permaslug` | *str* | :heavy_check_mark: | Exact model permaslug. | anthropic/claude-4.8-opus | -| `turn_range` | [components.TurnRange](../components/turnrange.mdx) | :heavy_check_mark: | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file +| `app_name` | *str* | ✅ | Published harness display label. | Hermes Agent | +| `app_slug` | *str* | ✅ | Stable public slug of the harness. | hermes-agent | +| `median_session_cost_usd` | *float* | ✅ | Median USD spend per sampled session. | 1.74 | +| `model_permaslug` | *str* | ✅ | Exact model permaslug. | anthropic/claude-4.8-opus | +| `turn_range` | [components.TurnRange](../components/turnrange.mdx) | ✅ | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file diff --git a/docs/components/sessioncostmeta.mdx b/docs/components/sessioncostmeta.mdx index f27d0ca7b..bfb4c473b 100644 --- a/docs/components/sessioncostmeta.mdx +++ b/docs/components/sessioncostmeta.mdx @@ -6,7 +6,7 @@ title: "SessionCostMeta" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `as_of` | *str* | :heavy_check_mark: | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | -| `version` | [components.SessionCostMetaVersion](../components/sessioncostmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | -| `window_days` | *Nullable[int]* | :heavy_check_mark: | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | -| `window_end_date` | *Nullable[str]* | :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 +| `as_of` | *str* | ✅ | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | +| `version` | [components.SessionCostMetaVersion](../components/sessioncostmetaversion.mdx) | ✅ | Dataset version. | | +| `window_days` | *Nullable[int]* | ✅ | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | +| `window_end_date` | *Nullable[str]* | ✅ | 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/components/sessioncostresponse.mdx b/docs/components/sessioncostresponse.mdx index 4b94d8dff..f52c308f4 100644 --- a/docs/components/sessioncostresponse.mdx +++ b/docs/components/sessioncostresponse.mdx @@ -6,5 +6,5 @@ title: "SessionCostResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | List[[components.SessionCostItem](../components/sessioncostitem.mdx)] | :heavy_check_mark: | N/A | -| `meta` | [components.SessionCostMeta](../components/sessioncostmeta.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.SessionCostItem](../components/sessioncostitem.mdx)] | ✅ | N/A | +| `meta` | [components.SessionCostMeta](../components/sessioncostmeta.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/shellcallitem.mdx b/docs/components/shellcallitem.mdx index 4e9f17f39..34ceee9dd 100644 --- a/docs/components/shellcallitem.mdx +++ b/docs/components/shellcallitem.mdx @@ -9,10 +9,10 @@ A shell command execution call (newer variant) | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [components.ShellCallItemAction](../components/shellcallitemaction.mdx) | :heavy_check_mark: | N/A | | -| `arguments` | *OptionalNullable[str]* | :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. | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `environment` | *Optional[Any]* | :heavy_minus_sign: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.ShellCallItemType](../components/shellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [components.ShellCallItemAction](../components/shellcallitemaction.mdx) | ✅ | N/A | | +| `arguments` | *OptionalNullable[str]* | ➖ | 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. | | +| `call_id` | *str* | ✅ | N/A | | +| `environment` | *Optional[Any]* | ➖ | N/A | | +| `id` | *OptionalNullable[str]* | ➖ | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [components.ShellCallItemType](../components/shellcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/shellcallitemaction.mdx b/docs/components/shellcallitemaction.mdx index cca3bb614..b94bb6571 100644 --- a/docs/components/shellcallitemaction.mdx +++ b/docs/components/shellcallitemaction.mdx @@ -6,6 +6,6 @@ title: "ShellCallItemAction" | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `commands` | List[*str*] | :heavy_check_mark: | N/A | -| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `timeout_ms` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `commands` | List[*str*] | ✅ | N/A | +| `max_output_length` | *OptionalNullable[int]* | ➖ | N/A | +| `timeout_ms` | *OptionalNullable[int]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/shellcalloutputcontent.mdx b/docs/components/shellcalloutputcontent.mdx index 9aaa17fdf..c95451e8e 100644 --- a/docs/components/shellcalloutputcontent.mdx +++ b/docs/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](../components/outcome.mdx) | :heavy_check_mark: | N/A | | -| `stderr` | *str* | :heavy_check_mark: | N/A | | -| `stdout` | *str* | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *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](../components/outcome.mdx) | ✅ | N/A | | +| `stderr` | *str* | ✅ | N/A | | +| `stdout` | *str* | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"outcome": \{
"exit_code": 0,
"type": "exit"
},
"stderr": "",
"stdout": "total 0\n"
} | \ No newline at end of file diff --git a/docs/components/shellcalloutputitem.mdx b/docs/components/shellcalloutputitem.mdx index 05e53b1f6..3f614cd9a 100644 --- a/docs/components/shellcalloutputitem.mdx +++ b/docs/components/shellcalloutputitem.mdx @@ -9,12 +9,12 @@ Output from a shell command execution (newer variant) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `container_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | List[[components.ShellCallOutputItemFile](../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[str]* | :heavy_minus_sign: | N/A | | -| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.ShellCallOutputItemTypeShellCallOutput](../components/shellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | | +| `container_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | The error message when the sandbox call failed before producing a result, as echoed from a failed `shell_call_output` emission. | | +| `files` | List[[components.ShellCallOutputItemFile](../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[str]* | ➖ | N/A | | +| `max_output_length` | *OptionalNullable[int]* | ➖ | N/A | | +| `output` | List[[components.ShellCallOutputContent](../components/shellcalloutputcontent.mdx)] | ✅ | N/A | | +| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [components.ShellCallOutputItemTypeShellCallOutput](../components/shellcalloutputitemtypeshellcalloutput.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/shellcalloutputitemfile.mdx b/docs/components/shellcalloutputitemfile.mdx index e4a0c69ef..851268c18 100644 --- a/docs/components/shellcalloutputitemfile.mdx +++ b/docs/components/shellcalloutputitemfile.mdx @@ -6,9 +6,9 @@ title: "ShellCallOutputItemFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `container_id` | *str* | :heavy_check_mark: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ShellCallOutputItemTypeContainerFileCitation](../components/shellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container_id` | *str* | ✅ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `file_id` | *str* | ✅ | N/A | +| `filename` | *str* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `type` | [components.ShellCallOutputItemTypeContainerFileCitation](../components/shellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/shellservertool.mdx b/docs/components/shellservertool.mdx index 0f55c3798..8dd61d106 100644 --- a/docs/components/shellservertool.mdx +++ b/docs/components/shellservertool.mdx @@ -9,4 +9,4 @@ Shell tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.ShellServerToolType](../components/shellservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.ShellServerToolType](../components/shellservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/shellservertoolconfig.mdx b/docs/components/shellservertoolconfig.mdx index c42fbf09d..07ebb17f5 100644 --- a/docs/components/shellservertoolconfig.mdx +++ b/docs/components/shellservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:shell server tool | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.ShellServerToolEngine]](../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` | [Optional[components.ShellServerToolEnvironment]](../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` | [Optional[components.ShellServerToolEngine]](../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` | [Optional[components.ShellServerToolEnvironment]](../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/components/shellservertoolopenrouter.mdx b/docs/components/shellservertoolopenrouter.mdx index fa031486a..990ac3f2c 100644 --- a/docs/components/shellservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.ShellServerToolConfig]](../components/shellservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | -| `type` | [components.ShellServerToolOpenRouterType](../components/shellservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.ShellServerToolConfig]](../components/shellservertoolconfig.mdx) | ➖ | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | +| `type` | [components.ShellServerToolOpenRouterType](../components/shellservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/signinterndaemonrequest.mdx b/docs/components/signinterndaemonrequest.mdx index b4bf06967..5ed4ce9b1 100644 --- a/docs/components/signinterndaemonrequest.mdx +++ b/docs/components/signinterndaemonrequest.mdx @@ -6,4 +6,4 @@ title: "SignInternDaemonRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `body_sha256` | *str* | :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 +| `body_sha256` | *str* | ✅ | 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/components/signinterndaemonresponse.mdx b/docs/components/signinterndaemonresponse.mdx index d989162b0..5da8e2eeb 100644 --- a/docs/components/signinterndaemonresponse.mdx +++ b/docs/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 | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `x_ori_invoke_signature` | *str* | :heavy_check_mark: | Base64 Ed25519 signature over the intern id, timestamp, user and body digest. | -| `x_ori_invoke_timestamp` | *str* | :heavy_check_mark: | Unix seconds at signing; the daemon refuses proofs older than its window. | -| `x_ori_invoke_user` | *str* | :heavy_check_mark: | The verified OAuth subject the proof names. Never taken from the request. | \ No newline at end of file +| `x_ori_invoke_signature` | *str* | ✅ | Base64 Ed25519 signature over the intern id, timestamp, user and body digest. | +| `x_ori_invoke_timestamp` | *str* | ✅ | Unix seconds at signing; the daemon refuses proofs older than its window. | +| `x_ori_invoke_user` | *str* | ✅ | The verified OAuth subject the proof names. Never taken from the request. | \ No newline at end of file diff --git a/docs/components/sourcecontent.mdx b/docs/components/sourcecontent.mdx index 792f40542..d56b7247d 100644 --- a/docs/components/sourcecontent.mdx +++ b/docs/components/sourcecontent.mdx @@ -6,5 +6,5 @@ title: "SourceContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `content` | [components.AnthropicDocumentBlockParamContent2](../components/anthropicdocumentblockparamcontent2.mdx) | :heavy_check_mark: | N/A | -| `type` | [components.SourceType](../components/sourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | [components.AnthropicDocumentBlockParamContent2](../components/anthropicdocumentblockparamcontent2.mdx) | ✅ | N/A | +| `type` | [components.SourceType](../components/sourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/speechinputreferenceaudio.mdx b/docs/components/speechinputreferenceaudio.mdx index f00281d13..2526a8b5d 100644 --- a/docs/components/speechinputreferenceaudio.mdx +++ b/docs/components/speechinputreferenceaudio.mdx @@ -9,5 +9,5 @@ Reference audio input for stateless voice cloning. Up to three parts per request | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `input_audio` | [components.SpeechInputReferenceAudioInput](../components/speechinputreferenceaudioinput.mdx) | :heavy_check_mark: | Reference audio input object | -| `type` | [components.SpeechInputReferenceAudioType](../components/speechinputreferenceaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `input_audio` | [components.SpeechInputReferenceAudioInput](../components/speechinputreferenceaudioinput.mdx) | ✅ | Reference audio input object | +| `type` | [components.SpeechInputReferenceAudioType](../components/speechinputreferenceaudiotype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/speechinputreferenceaudioinput.mdx b/docs/components/speechinputreferenceaudioinput.mdx index c16ea82c8..671117175 100644 --- a/docs/components/speechinputreferenceaudioinput.mdx +++ b/docs/components/speechinputreferenceaudioinput.mdx @@ -9,6 +9,6 @@ Reference audio input object | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *Optional[str]* | :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_` | *Optional[str]* | :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` | *Optional[str]* | :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` | *Optional[str]* | ➖ | 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_` | *Optional[str]* | ➖ | Audio format of the reference audio (e.g., wav, mp3). Optional; most providers detect the format from the audio bytes. | wav | +| `url` | *Optional[str]* | ➖ | 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/components/speechinputreferenceimage.mdx b/docs/components/speechinputreferenceimage.mdx index 068290f70..c02d1d3cd 100644 --- a/docs/components/speechinputreferenceimage.mdx +++ b/docs/components/speechinputreferenceimage.mdx @@ -9,5 +9,5 @@ Reference image describing the desired voice. Cannot be combined with `input_aud | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `image_url` | [components.SpeechInputReferenceImageInput](../components/speechinputreferenceimageinput.mdx) | :heavy_check_mark: | Reference image input object | -| `type` | [components.SpeechInputReferenceImageType](../components/speechinputreferenceimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `image_url` | [components.SpeechInputReferenceImageInput](../components/speechinputreferenceimageinput.mdx) | ✅ | Reference image input object | +| `type` | [components.SpeechInputReferenceImageType](../components/speechinputreferenceimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/speechinputreferenceimageinput.mdx b/docs/components/speechinputreferenceimageinput.mdx index 127f005a6..051444219 100644 --- a/docs/components/speechinputreferenceimageinput.mdx +++ b/docs/components/speechinputreferenceimageinput.mdx @@ -9,4 +9,4 @@ Reference image input object | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | *str* | :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` | *str* | ✅ | 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/components/speechinputreferencetext.mdx b/docs/components/speechinputreferencetext.mdx index af437e9f3..0e7869df3 100644 --- a/docs/components/speechinputreferencetext.mdx +++ b/docs/components/speechinputreferencetext.mdx @@ -9,5 +9,5 @@ Transcript of an `input_audio` part | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `text` | *str* | :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](../components/speechinputreferencetexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `text` | *str* | ✅ | 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](../components/speechinputreferencetexttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/speechrequest.mdx b/docs/components/speechrequest.mdx index e87bc0ab2..15e0eb0d5 100644 --- a/docs/components/speechrequest.mdx +++ b/docs/components/speechrequest.mdx @@ -9,14 +9,14 @@ Text-to-speech request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `input` | [components.SpeechInput](../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 supported by Gemini TTS models and by Fish Audio models other than S1. | Hello world | -| `input_references` | List[[components.SpeechInputReference](../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` | *Optional[str]* | :heavy_minus_sign: | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers. | Speak in a warm and friendly tone. | -| `model` | *str* | :heavy_check_mark: | TTS model identifier | mistralai/voxtral-mini-tts-2603 | -| `provider` | [Optional[components.SpeechRequestProvider]](../components/speechrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `response_format` | [Optional[components.SpeechRequestResponseFormat]](../components/speechrequestresponseformat.mdx) | :heavy_minus_sign: | Audio output format | pcm | -| `session_id` | *Optional[str]* | :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` | *Optional[float]* | :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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file +| `input` | [components.SpeechInput](../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 supported by Gemini TTS models and by Fish Audio models other than S1. | Hello world | +| `input_references` | List[[components.SpeechInputReference](../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` | *Optional[str]* | ➖ | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers. | Speak in a warm and friendly tone. | +| `model` | *str* | ✅ | TTS model identifier | mistralai/voxtral-mini-tts-2603 | +| `provider` | [Optional[components.SpeechRequestProvider]](../components/speechrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `response_format` | [Optional[components.SpeechRequestResponseFormat]](../components/speechrequestresponseformat.mdx) | ➖ | Audio output format | pcm | +| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | 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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file diff --git a/docs/components/speechrequestprovider.mdx b/docs/components/speechrequestprovider.mdx index fbfa71493..f2d851d2e 100644 --- a/docs/components/speechrequestprovider.mdx +++ b/docs/components/speechrequestprovider.mdx @@ -9,6 +9,6 @@ Provider configuration: data policy routing preferences (`zdr`, `data_collection | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data_collection` | [OptionalNullable[components.SpeechRequestDataCollection]](../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` | [Optional[components.ProviderOptions]](../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[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 +| `data_collection` | [OptionalNullable[components.SpeechRequestDataCollection]](../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` | [Optional[components.ProviderOptions]](../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[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/components/speechturn.mdx b/docs/components/speechturn.mdx index db37aa4e7..2297b61a5 100644 --- a/docs/components/speechturn.mdx +++ b/docs/components/speechturn.mdx @@ -6,6 +6,6 @@ title: "SpeechTurn" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `instructions` | *Optional[str]* | :heavy_minus_sign: | Delivery instructions for this turn, such as tone, pacing, or emotion. Overrides the top-level `instructions`. | whispering | -| `text` | *str* | :heavy_check_mark: | Text to synthesize | Hi Jane. | -| `voice` | *Optional[str]* | :heavy_minus_sign: | Voice for this turn. Defaults to the top-level `voice`. | Kore | \ No newline at end of file +| `instructions` | *Optional[str]* | ➖ | Delivery instructions for this turn, such as tone, pacing, or emotion. Overrides the top-level `instructions`. | whispering | +| `text` | *str* | ✅ | Text to synthesize | Hi Jane. | +| `voice` | *Optional[str]* | ➖ | Voice for this turn. Defaults to the top-level `voice`. | Kore | \ No newline at end of file diff --git a/docs/components/stance.mdx b/docs/components/stance.mdx index 3a93298ea..e743de1e5 100644 --- a/docs/components/stance.mdx +++ b/docs/components/stance.mdx @@ -6,5 +6,5 @@ title: "Stance" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | :heavy_check_mark: | N/A | -| `stance` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `model` | *str* | ✅ | N/A | +| `stance` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenfinishreasonis.mdx b/docs/components/stopservertoolswhenfinishreasonis.mdx index ef2f143f7..bf4741108 100644 --- a/docs/components/stopservertoolswhenfinishreasonis.mdx +++ b/docs/components/stopservertoolswhenfinishreasonis.mdx @@ -9,5 +9,5 @@ Stop when the upstream model emits this finish reason (e.g. `length`). | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `reason` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenFinishReasonIsType](../components/stopservertoolswhenfinishreasonistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `reason` | *str* | ✅ | N/A | +| `type` | [components.StopServerToolsWhenFinishReasonIsType](../components/stopservertoolswhenfinishreasonistype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenhastoolcall.mdx b/docs/components/stopservertoolswhenhastoolcall.mdx index 890af332e..f5418eaf3 100644 --- a/docs/components/stopservertoolswhenhastoolcall.mdx +++ b/docs/components/stopservertoolswhenhastoolcall.mdx @@ -9,5 +9,5 @@ Stop after a tool with this name has been called. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `tool_name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenHasToolCallType](../components/stopservertoolswhenhastoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `tool_name` | *str* | ✅ | N/A | +| `type` | [components.StopServerToolsWhenHasToolCallType](../components/stopservertoolswhenhastoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenmaxcost.mdx b/docs/components/stopservertoolswhenmaxcost.mdx index 11ec52648..33399e736 100644 --- a/docs/components/stopservertoolswhenmaxcost.mdx +++ b/docs/components/stopservertoolswhenmaxcost.mdx @@ -9,5 +9,5 @@ Stop once cumulative cost across the loop exceeds this dollar threshold. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `max_cost_in_dollars` | *float* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenMaxCostType](../components/stopservertoolswhenmaxcosttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `max_cost_in_dollars` | *float* | ✅ | N/A | +| `type` | [components.StopServerToolsWhenMaxCostType](../components/stopservertoolswhenmaxcosttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenmaxtokensused.mdx b/docs/components/stopservertoolswhenmaxtokensused.mdx index 33d4618b4..e70c236f8 100644 --- a/docs/components/stopservertoolswhenmaxtokensused.mdx +++ b/docs/components/stopservertoolswhenmaxtokensused.mdx @@ -9,5 +9,5 @@ Stop once cumulative token usage across the loop exceeds this threshold. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `max_tokens` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenMaxTokensUsedType](../components/stopservertoolswhenmaxtokensusedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `max_tokens` | *int* | ✅ | N/A | +| `type` | [components.StopServerToolsWhenMaxTokensUsedType](../components/stopservertoolswhenmaxtokensusedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/stopservertoolswhenstepcountis.mdx b/docs/components/stopservertoolswhenstepcountis.mdx index 0544b66ff..d49ce5c1d 100644 --- a/docs/components/stopservertoolswhenstepcountis.mdx +++ b/docs/components/stopservertoolswhenstepcountis.mdx @@ -9,5 +9,5 @@ Stop after the agent loop has executed this many steps. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `step_count` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenStepCountIsType](../components/stopservertoolswhenstepcountistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `step_count` | *int* | ✅ | N/A | +| `type` | [components.StopServerToolsWhenStepCountIsType](../components/stopservertoolswhenstepcountistype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/storedprompttemplate.mdx b/docs/components/storedprompttemplate.mdx index a9461bc3e..67f2f9e42 100644 --- a/docs/components/storedprompttemplate.mdx +++ b/docs/components/storedprompttemplate.mdx @@ -6,5 +6,5 @@ title: "StoredPromptTemplate" | Field | Type | Required | Description | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `variables` | Dict[str, [components.Variables](../components/variables.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `id` | *str* | ✅ | N/A | +| `variables` | Dict[str, [components.Variables](../components/variables.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/streameventsresponsecompleted.mdx b/docs/components/streameventsresponsecompleted.mdx index 35bdaf313..c510dfb27 100644 --- a/docs/components/streameventsresponsecompleted.mdx +++ b/docs/components/streameventsresponsecompleted.mdx @@ -9,6 +9,6 @@ Event emitted when a response has completed successfully | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseCompletedType](../components/streameventsresponsecompletedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | ✅ | N/A | | +| `type` | [components.StreamEventsResponseCompletedType](../components/streameventsresponsecompletedtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/streameventsresponsefailed.mdx b/docs/components/streameventsresponsefailed.mdx index 2fe71e963..854bcab46 100644 --- a/docs/components/streameventsresponsefailed.mdx +++ b/docs/components/streameventsresponsefailed.mdx @@ -9,6 +9,6 @@ Event emitted when a response has failed | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseFailedType](../components/streameventsresponsefailedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | ✅ | N/A | | +| `type` | [components.StreamEventsResponseFailedType](../components/streameventsresponsefailedtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/streameventsresponseincomplete.mdx b/docs/components/streameventsresponseincomplete.mdx index 0abd1db55..2e1458b75 100644 --- a/docs/components/streameventsresponseincomplete.mdx +++ b/docs/components/streameventsresponseincomplete.mdx @@ -9,6 +9,6 @@ Event emitted when a response is incomplete | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](../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
}
} | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseIncompleteType](../components/streameventsresponseincompletetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [components.OpenResponsesResult](../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
}
} | +| `sequence_number` | *int* | ✅ | N/A | | +| `type` | [components.StreamEventsResponseIncompleteType](../components/streameventsresponseincompletetype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/streameventsresponseoutputitemadded.mdx b/docs/components/streameventsresponseoutputitemadded.mdx index 8121198a7..c74d14f11 100644 --- a/docs/components/streameventsresponseoutputitemadded.mdx +++ b/docs/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](../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"
} | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseOutputItemAddedType](../components/streameventsresponseoutputitemaddedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `item` | [components.OutputItems](../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"
} | +| `output_index` | *int* | ✅ | N/A | | +| `sequence_number` | *int* | ✅ | N/A | | +| `type` | [components.StreamEventsResponseOutputItemAddedType](../components/streameventsresponseoutputitemaddedtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/streameventsresponseoutputitemdone.mdx b/docs/components/streameventsresponseoutputitemdone.mdx index 5d02fd8ea..19a80220b 100644 --- a/docs/components/streameventsresponseoutputitemdone.mdx +++ b/docs/components/streameventsresponseoutputitemdone.mdx @@ -9,7 +9,7 @@ Event emitted when an output item is complete | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `item` | [components.OutputItems](../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"
} | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseOutputItemDoneType](../components/streameventsresponseoutputitemdonetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `item` | [components.OutputItems](../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"
} | +| `output_index` | *int* | ✅ | N/A | | +| `sequence_number` | *int* | ✅ | N/A | | +| `type` | [components.StreamEventsResponseOutputItemDoneType](../components/streameventsresponseoutputitemdonetype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/streamlogprob.mdx b/docs/components/streamlogprob.mdx index 398824645..1f5198be9 100644 --- a/docs/components/streamlogprob.mdx +++ b/docs/components/streamlogprob.mdx @@ -9,7 +9,7 @@ Log probability information for a token | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | :heavy_minus_sign: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `top_logprobs` | List[[components.StreamLogprobTopLogprob](../components/streamlogprobtoplogprob.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | ➖ | N/A | +| `logprob` | *float* | ✅ | N/A | +| `token` | *str* | ✅ | N/A | +| `top_logprobs` | List[[components.StreamLogprobTopLogprob](../components/streamlogprobtoplogprob.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/streamlogprobtoplogprob.mdx b/docs/components/streamlogprobtoplogprob.mdx index 972fa7f69..d20165881 100644 --- a/docs/components/streamlogprobtoplogprob.mdx +++ b/docs/components/streamlogprobtoplogprob.mdx @@ -9,6 +9,6 @@ Alternative token with its log probability | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | :heavy_minus_sign: | N/A | -| `logprob` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `token` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `bytes_` | List[*int*] | ➖ | N/A | +| `logprob` | *Optional[float]* | ➖ | N/A | +| `token` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/stt.mdx b/docs/components/stt.mdx index 5ebe2d199..b73a789e8 100644 --- a/docs/components/stt.mdx +++ b/docs/components/stt.mdx @@ -6,6 +6,6 @@ title: "STT" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../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` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/sttentity.mdx b/docs/components/sttentity.mdx index 70d1ffaf4..d88efcc75 100644 --- a/docs/components/sttentity.mdx +++ b/docs/components/sttentity.mdx @@ -9,7 +9,7 @@ A detected entity, returned when the provider runs entity detection | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `end_char` | *int* | :heavy_check_mark: | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | -| `start_char` | *int* | :heavy_check_mark: | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | -| `text` | *str* | :heavy_check_mark: | Entity text as it appears in the transcript | | -| `type` | *str* | :heavy_check_mark: | Provider entity type label | name | \ No newline at end of file +| `end_char` | *int* | ✅ | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | +| `start_char` | *int* | ✅ | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | +| `text` | *str* | ✅ | Entity text as it appears in the transcript | | +| `type` | *str* | ✅ | Provider entity type label | name | \ No newline at end of file diff --git a/docs/components/sttinlineinputaudio.mdx b/docs/components/sttinlineinputaudio.mdx index dfcdc6b10..099d46be9 100644 --- a/docs/components/sttinlineinputaudio.mdx +++ b/docs/components/sttinlineinputaudio.mdx @@ -9,5 +9,5 @@ Inline base64 audio input for speech-to-text | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | Base64-encoded audio data (raw bytes, not a data URI) | -| `format_` | *str* | :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` | *str* | ✅ | Base64-encoded audio data (raw bytes, not a data URI) | +| `format_` | *str* | ✅ | 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/components/sttrequest.mdx b/docs/components/sttrequest.mdx index 928d5db30..9dffd6e29 100644 --- a/docs/components/sttrequest.mdx +++ b/docs/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` | *Optional[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 | -| `input_audio` | [components.STTInputAudio](../components/sttinputaudio.mdx) | :heavy_check_mark: | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | -| `keyterms` | List[*str*] | :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` | *Optional[str]* | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | -| `model` | *str* | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | -| `provider` | [Optional[components.STTRequestProvider]](../components/sttrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `response_format` | [Optional[components.STTRequestResponseFormat]](../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 | -| `session_id` | *Optional[str]* | :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` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature for transcription | 0 | -| `timestamp_granularities` | List[[components.STTTimestampGranularity](../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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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` | *Optional[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 | +| `input_audio` | [components.STTInputAudio](../components/sttinputaudio.mdx) | ✅ | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | +| `keyterms` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | +| `model` | *str* | ✅ | STT model identifier | openai/whisper-large-v3 | +| `provider` | [Optional[components.STTRequestProvider]](../components/sttrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `response_format` | [Optional[components.STTRequestResponseFormat]](../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 | +| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | Sampling temperature for transcription | 0 | +| `timestamp_granularities` | List[[components.STTTimestampGranularity](../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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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/components/sttrequestprovider.mdx b/docs/components/sttrequestprovider.mdx index ddc964b62..cb144551e 100644 --- a/docs/components/sttrequestprovider.mdx +++ b/docs/components/sttrequestprovider.mdx @@ -9,6 +9,6 @@ Provider configuration: data policy routing preferences (`zdr`, `data_collection | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data_collection` | [OptionalNullable[components.STTRequestDataCollection]](../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` | [Optional[components.ProviderOptions]](../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[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 +| `data_collection` | [OptionalNullable[components.STTRequestDataCollection]](../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` | [Optional[components.ProviderOptions]](../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[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/components/sttresponse.mdx b/docs/components/sttresponse.mdx index 8cc193265..f6d005b67 100644 --- a/docs/components/sttresponse.mdx +++ b/docs/components/sttresponse.mdx @@ -9,13 +9,13 @@ STT response containing transcribed text and optional usage statistics | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `confidence` | *Optional[float]* | :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` | *Optional[float]* | :heavy_minus_sign: | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | -| `entities` | List[[components.STTEntity](../components/sttentity.mdx)] | :heavy_minus_sign: | Detected entities with character offsets into text, present when the provider runs entity detection | | -| `language` | *Optional[str]* | :heavy_minus_sign: | Detected or forced language, present when response_format is verbose_json | english | -| `language_confidence` | *Optional[float]* | :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` | List[[components.STTSegment](../components/sttsegment.mdx)] | :heavy_minus_sign: | Timestamped transcript segments, present when response_format is verbose_json | | -| `task` | *Optional[str]* | :heavy_minus_sign: | The task performed, present when response_format is verbose_json | transcribe | -| `text` | *str* | :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` | [Optional[components.STTUsage]](../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` | List[[components.STTWord](../components/sttword.mdx)] | :heavy_minus_sign: | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file +| `confidence` | *Optional[float]* | ➖ | 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` | *Optional[float]* | ➖ | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | +| `entities` | List[[components.STTEntity](../components/sttentity.mdx)] | ➖ | Detected entities with character offsets into text, present when the provider runs entity detection | | +| `language` | *Optional[str]* | ➖ | Detected or forced language, present when response_format is verbose_json | english | +| `language_confidence` | *Optional[float]* | ➖ | 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` | List[[components.STTSegment](../components/sttsegment.mdx)] | ➖ | Timestamped transcript segments, present when response_format is verbose_json | | +| `task` | *Optional[str]* | ➖ | The task performed, present when response_format is verbose_json | transcribe | +| `text` | *str* | ✅ | 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` | [Optional[components.STTUsage]](../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` | List[[components.STTWord](../components/sttword.mdx)] | ➖ | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file diff --git a/docs/components/sttsegment.mdx b/docs/components/sttsegment.mdx index dbe1e88ec..26d36a947 100644 --- a/docs/components/sttsegment.mdx +++ b/docs/components/sttsegment.mdx @@ -9,16 +9,16 @@ A timestamped transcript segment, returned when response_format is verbose_json | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `avg_logprob` | *Optional[float]* | :heavy_minus_sign: | Average log probability of the segment | | -| `channel` | *Optional[int]* | :heavy_minus_sign: | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | -| `compression_ratio` | *Optional[float]* | :heavy_minus_sign: | Compression ratio of the segment | | -| `end` | *float* | :heavy_check_mark: | Segment end time in seconds | 3.2 | -| `id` | *int* | :heavy_check_mark: | Segment index within the transcript | 0 | -| `no_speech_prob` | *Optional[float]* | :heavy_minus_sign: | Probability the segment contains no speech | | -| `seek` | *Optional[int]* | :heavy_minus_sign: | Seek offset of the segment | 0 | -| `speaker` | *Optional[int]* | :heavy_minus_sign: | Speaker index for the segment, present when the provider returns diarization data | 0 | -| `speaker_label` | *Optional[str]* | :heavy_minus_sign: | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | -| `start` | *float* | :heavy_check_mark: | Segment start time in seconds | 0 | -| `temperature` | *Optional[float]* | :heavy_minus_sign: | Temperature used for the segment | | -| `text` | *str* | :heavy_check_mark: | Transcribed text of the segment | Hello there. | -| `tokens` | List[*int*] | :heavy_minus_sign: | Token IDs of the segment | | \ No newline at end of file +| `avg_logprob` | *Optional[float]* | ➖ | Average log probability of the segment | | +| `channel` | *Optional[int]* | ➖ | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | +| `compression_ratio` | *Optional[float]* | ➖ | Compression ratio of the segment | | +| `end` | *float* | ✅ | Segment end time in seconds | 3.2 | +| `id` | *int* | ✅ | Segment index within the transcript | 0 | +| `no_speech_prob` | *Optional[float]* | ➖ | Probability the segment contains no speech | | +| `seek` | *Optional[int]* | ➖ | Seek offset of the segment | 0 | +| `speaker` | *Optional[int]* | ➖ | Speaker index for the segment, present when the provider returns diarization data | 0 | +| `speaker_label` | *Optional[str]* | ➖ | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | +| `start` | *float* | ✅ | Segment start time in seconds | 0 | +| `temperature` | *Optional[float]* | ➖ | Temperature used for the segment | | +| `text` | *str* | ✅ | Transcribed text of the segment | Hello there. | +| `tokens` | List[*int*] | ➖ | Token IDs of the segment | | \ No newline at end of file diff --git a/docs/components/stturlinputaudio.mdx b/docs/components/stturlinputaudio.mdx index bc1eb6aef..1162f536a 100644 --- a/docs/components/stturlinputaudio.mdx +++ b/docs/components/stturlinputaudio.mdx @@ -9,5 +9,5 @@ Audio input fetched by the provider from a URL | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format_` | *Optional[str]* | :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` | *str* | :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_` | *Optional[str]* | ➖ | Audio format of the file at the URL. Defaults to the extension of the URL path; required when the path has no extension. | +| `url` | *str* | ✅ | 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/components/sttusage.mdx b/docs/components/sttusage.mdx index f0b56839c..0ef1266dd 100644 --- a/docs/components/sttusage.mdx +++ b/docs/components/sttusage.mdx @@ -9,8 +9,8 @@ Aggregated usage statistics for the request | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `cost` | *Optional[float]* | :heavy_minus_sign: | Total cost of the request in USD | 0.000508 | -| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of input tokens billed for this request | 83 | -| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of output tokens generated | 30 | -| `seconds` | *Optional[float]* | :heavy_minus_sign: | Duration of the input audio in seconds | 9.2 | -| `total_tokens` | *Optional[int]* | :heavy_minus_sign: | Total number of tokens used (input + output) | 113 | \ No newline at end of file +| `cost` | *Optional[float]* | ➖ | Total cost of the request in USD | 0.000508 | +| `input_tokens` | *Optional[int]* | ➖ | Number of input tokens billed for this request | 83 | +| `output_tokens` | *Optional[int]* | ➖ | Number of output tokens generated | 30 | +| `seconds` | *Optional[float]* | ➖ | Duration of the input audio in seconds | 9.2 | +| `total_tokens` | *Optional[int]* | ➖ | Total number of tokens used (input + output) | 113 | \ No newline at end of file diff --git a/docs/components/sttword.mdx b/docs/components/sttword.mdx index 48e877265..430df270f 100644 --- a/docs/components/sttword.mdx +++ b/docs/components/sttword.mdx @@ -9,11 +9,11 @@ A timestamped word, returned when the provider includes word-level timestamps | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `channel` | *Optional[int]* | :heavy_minus_sign: | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | -| `confidence` | *Optional[float]* | :heavy_minus_sign: | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | -| `end` | *float* | :heavy_check_mark: | Word end time in seconds | 0.4 | -| `speaker` | *Optional[int]* | :heavy_minus_sign: | Speaker index for the word, present when the provider returns diarization data | 0 | -| `speaker_label` | *Optional[str]* | :heavy_minus_sign: | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | -| `start` | *float* | :heavy_check_mark: | Word start time in seconds | 0 | -| `type` | [Optional[components.STTWordType]](../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` | *str* | :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` | *Optional[int]* | ➖ | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | +| `confidence` | *Optional[float]* | ➖ | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | +| `end` | *float* | ✅ | Word end time in seconds | 0.4 | +| `speaker` | *Optional[int]* | ➖ | Speaker index for the word, present when the provider returns diarization data | 0 | +| `speaker_label` | *Optional[str]* | ➖ | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | +| `start` | *float* | ✅ | Word start time in seconds | 0 | +| `type` | [Optional[components.STTWordType]](../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` | *str* | ✅ | 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/components/subagentnestedtool.mdx b/docs/components/subagentnestedtool.mdx index 957462250..67e7d558e 100644 --- a/docs/components/subagentnestedtool.mdx +++ b/docs/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` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `type` | *str* | :heavy_check_mark: | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file +| `parameters` | Dict[str, *Any*] | ➖ | N/A | | +| `type` | *str* | ✅ | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file diff --git a/docs/components/subagentreasoning.mdx b/docs/components/subagentreasoning.mdx index c1d3baea5..129b89f29 100644 --- a/docs/components/subagentreasoning.mdx +++ b/docs/components/subagentreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the subagent call. Use this to control reas | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `effort` | [Optional[components.SubagentReasoningEffort]](../components/subagentreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the subagent call. | -| `max_tokens` | *Optional[int]* | :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` | [Optional[components.SubagentReasoningEffort]](../components/subagentreasoningeffort.mdx) | ➖ | Reasoning effort level for the subagent call. | +| `max_tokens` | *Optional[int]* | ➖ | 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/components/subagentservertoolconfig.mdx b/docs/components/subagentservertoolconfig.mdx index 3e6825bc8..c314c4317 100644 --- a/docs/components/subagentservertoolconfig.mdx +++ b/docs/components/subagentservertoolconfig.mdx @@ -9,13 +9,13 @@ Configuration for one openrouter:subagent server tool entry. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `inherit_functions` | *Optional[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 | -| `inherited_function_names` | List[*str*] | :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` | *Optional[str]* | :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. | -| `max_completion_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | -| `max_tool_calls` | *Optional[int]* | :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` | *Optional[str]* | :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` | *Optional[str]* | :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` | [Optional[components.SubagentReasoning]](../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` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | -| `tools` | List[[components.SubagentNestedTool](../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 +| `inherit_functions` | *Optional[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 | +| `inherited_function_names` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | 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. | +| `max_completion_tokens` | *Optional[int]* | ➖ | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | +| `max_tool_calls` | *Optional[int]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.SubagentReasoning]](../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` | *Optional[float]* | ➖ | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | +| `tools` | List[[components.SubagentNestedTool](../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/components/subagentservertoolopenrouter.mdx b/docs/components/subagentservertoolopenrouter.mdx index 3b1eb0a63..86cc77a9a 100644 --- a/docs/components/subagentservertoolopenrouter.mdx +++ b/docs/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` | [Optional[components.SubagentServerToolConfig]](../components/subagentservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | -| `type` | [components.SubagentServerToolOpenRouterType](../components/subagentservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.SubagentServerToolConfig]](../components/subagentservertoolconfig.mdx) | ➖ | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | +| `type` | [components.SubagentServerToolOpenRouterType](../components/subagentservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/submitgenerationfeedbackrequest.mdx b/docs/components/submitgenerationfeedbackrequest.mdx index 4ac73ca3e..80f32cd22 100644 --- a/docs/components/submitgenerationfeedbackrequest.mdx +++ b/docs/components/submitgenerationfeedbackrequest.mdx @@ -9,6 +9,6 @@ Structured feedback about a specific generation | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `category` | [components.SubmitGenerationFeedbackRequestCategory](../components/submitgenerationfeedbackrequestcategory.mdx) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | -| `comment` | *Optional[str]* | :heavy_minus_sign: | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | -| `generation_id` | *str* | :heavy_check_mark: | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file +| `category` | [components.SubmitGenerationFeedbackRequestCategory](../components/submitgenerationfeedbackrequestcategory.mdx) | ✅ | The category of feedback being reported | incorrect_response | +| `comment` | *Optional[str]* | ➖ | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | +| `generation_id` | *str* | ✅ | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file diff --git a/docs/components/submitgenerationfeedbackresponse.mdx b/docs/components/submitgenerationfeedbackresponse.mdx index ba546e044..5f761246a 100644 --- a/docs/components/submitgenerationfeedbackresponse.mdx +++ b/docs/components/submitgenerationfeedbackresponse.mdx @@ -9,4 +9,4 @@ Confirmation that the feedback was recorded | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `data` | [components.SubmitGenerationFeedbackResponseData](../components/submitgenerationfeedbackresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.SubmitGenerationFeedbackResponseData](../components/submitgenerationfeedbackresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/submitgenerationfeedbackresponsedata.mdx b/docs/components/submitgenerationfeedbackresponsedata.mdx index 2b6ccfe57..144ea4164 100644 --- a/docs/components/submitgenerationfeedbackresponsedata.mdx +++ b/docs/components/submitgenerationfeedbackresponsedata.mdx @@ -6,4 +6,4 @@ title: "SubmitGenerationFeedbackResponseData" | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `success` | *Literal[True]* | :heavy_check_mark: | Whether the feedback was recorded | true | \ No newline at end of file +| `success` | *Literal[True]* | ✅ | Whether the feedback was recorded | true | \ No newline at end of file diff --git a/docs/components/suspendinternresponse.mdx b/docs/components/suspendinternresponse.mdx index 7a513bd20..8af1f9d2c 100644 --- a/docs/components/suspendinternresponse.mdx +++ b/docs/components/suspendinternresponse.mdx @@ -6,4 +6,4 @@ title: "SuspendInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `suspended` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `suspended` | *Literal[True]* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/switchyardrouterplugin.mdx b/docs/components/switchyardrouterplugin.mdx index 7a3a09ce0..468116091 100644 --- a/docs/components/switchyardrouterplugin.mdx +++ b/docs/components/switchyardrouterplugin.mdx @@ -6,6 +6,6 @@ title: "SwitchyardRouterPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `algorithm` | [Optional[components.Algorithm]](../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](../components/switchyardrouterpluginid.mdx) | :heavy_check_mark: | N/A | | -| `judge_model` | *Optional[str]* | :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` | [Optional[components.Algorithm]](../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](../components/switchyardrouterpluginid.mdx) | ✅ | N/A | | +| `judge_model` | *Optional[str]* | ➖ | 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/components/taskbudget.mdx b/docs/components/taskbudget.mdx index c98814d6f..676bd423e 100644 --- a/docs/components/taskbudget.mdx +++ b/docs/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[int]* | :heavy_minus_sign: | N/A | -| `total` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.TypeTokens](../components/typetokens.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `remaining` | *OptionalNullable[int]* | ➖ | N/A | +| `total` | *int* | ✅ | N/A | +| `type` | [components.TypeTokens](../components/typetokens.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/taskclassificationitem.mdx b/docs/components/taskclassificationitem.mdx index 905d90909..9aef28799 100644 --- a/docs/components/taskclassificationitem.mdx +++ b/docs/components/taskclassificationitem.mdx @@ -6,11 +6,11 @@ title: "TaskClassificationItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `category_token_share` | *float* | :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 | -| `category_usage_share` | *float* | :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 | -| `display_name` | *str* | :heavy_check_mark: | Human-readable label for the classification. | Code Generation | -| `macro_category` | *str* | :heavy_check_mark: | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | -| `models` | List[[components.TaskClassificationModel](../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` | *str* | :heavy_check_mark: | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | -| `token_share` | *float* | :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 | -| `usage_share` | *float* | :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 +| `category_token_share` | *float* | ✅ | 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 | +| `category_usage_share` | *float* | ✅ | 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 | +| `display_name` | *str* | ✅ | Human-readable label for the classification. | Code Generation | +| `macro_category` | *str* | ✅ | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | +| `models` | List[[components.TaskClassificationModel](../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` | *str* | ✅ | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | +| `token_share` | *float* | ✅ | 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 | +| `usage_share` | *float* | ✅ | 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/components/taskclassificationmacrocategory.mdx b/docs/components/taskclassificationmacrocategory.mdx index 1f45abf4c..cebaae8e5 100644 --- a/docs/components/taskclassificationmacrocategory.mdx +++ b/docs/components/taskclassificationmacrocategory.mdx @@ -6,7 +6,7 @@ title: "TaskClassificationMacroCategory" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *str* | :heavy_check_mark: | Macro-category identifier. | code | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the macro-category. | Code | -| `token_share` | *float* | :heavy_check_mark: | Combined token share of all classifications in this macro-category (0–1). | 0.52 | -| `usage_share` | *float* | :heavy_check_mark: | Combined usage share of all classifications in this macro-category (0–1). | 0.45 | \ No newline at end of file +| `key` | *str* | ✅ | Macro-category identifier. | code | +| `label` | *str* | ✅ | Human-readable label for the macro-category. | Code | +| `token_share` | *float* | ✅ | Combined token share of all classifications in this macro-category (0–1). | 0.52 | +| `usage_share` | *float* | ✅ | Combined usage share of all classifications in this macro-category (0–1). | 0.45 | \ No newline at end of file diff --git a/docs/components/taskclassificationmodel.mdx b/docs/components/taskclassificationmodel.mdx index 137c9bc4a..14ebe1063 100644 --- a/docs/components/taskclassificationmodel.mdx +++ b/docs/components/taskclassificationmodel.mdx @@ -6,6 +6,6 @@ title: "TaskClassificationModel" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Model identifier (permaslug). | openai/gpt-4.1-mini | -| `tag_token_share` | *float* | :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 | -| `tag_usage_share` | *float* | :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` | *str* | ✅ | Model identifier (permaslug). | openai/gpt-4.1-mini | +| `tag_token_share` | *float* | ✅ | 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 | +| `tag_usage_share` | *float* | ✅ | 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/components/taskclassificationresponse.mdx b/docs/components/taskclassificationresponse.mdx index 40e0bc7f5..bec951d2c 100644 --- a/docs/components/taskclassificationresponse.mdx +++ b/docs/components/taskclassificationresponse.mdx @@ -6,4 +6,4 @@ title: "TaskClassificationResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `data` | [components.TaskClassificationResponseData](../components/taskclassificationresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.TaskClassificationResponseData](../components/taskclassificationresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/taskclassificationresponsedata.mdx b/docs/components/taskclassificationresponsedata.mdx index a22f20ac9..53a1a3889 100644 --- a/docs/components/taskclassificationresponsedata.mdx +++ b/docs/components/taskclassificationresponsedata.mdx @@ -6,7 +6,7 @@ title: "TaskClassificationResponseData" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `as_of` | *str* | :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` | List[[components.TaskClassificationItem](../components/taskclassificationitem.mdx)] | :heavy_check_mark: | Per-task classification market-share data, sorted by usage_share descending. | | -| `macro_categories` | List[[components.TaskClassificationMacroCategory](../components/taskclassificationmacrocategory.mdx)] | :heavy_check_mark: | Aggregate market-share data per macro-category (code, data, agent, general). | | -| `window_days` | *int* | :heavy_check_mark: | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file +| `as_of` | *str* | ✅ | 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` | List[[components.TaskClassificationItem](../components/taskclassificationitem.mdx)] | ✅ | Per-task classification market-share data, sorted by usage_share descending. | | +| `macro_categories` | List[[components.TaskClassificationMacroCategory](../components/taskclassificationmacrocategory.mdx)] | ✅ | Aggregate market-share data per macro-category (code, data, agent, general). | | +| `window_days` | *int* | ✅ | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file diff --git a/docs/components/textdeltaevent.mdx b/docs/components/textdeltaevent.mdx index 8214536b8..e3b3ecec1 100644 --- a/docs/components/textdeltaevent.mdx +++ b/docs/components/textdeltaevent.mdx @@ -9,10 +9,10 @@ Event emitted when a text delta is streamed | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `logprobs` | List[[components.StreamLogprob](../components/streamlogprob.mdx)] | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.TextDeltaEventType](../components/textdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content_index` | *int* | ✅ | N/A | +| `delta` | *str* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `logprobs` | List[[components.StreamLogprob](../components/streamlogprob.mdx)] | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.TextDeltaEventType](../components/textdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/textdoneevent.mdx b/docs/components/textdoneevent.mdx index d2d166000..54ae977e0 100644 --- a/docs/components/textdoneevent.mdx +++ b/docs/components/textdoneevent.mdx @@ -9,10 +9,10 @@ Event emitted when text streaming is complete | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `logprobs` | List[[components.StreamLogprob](../components/streamlogprob.mdx)] | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TextDoneEventType](../components/textdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content_index` | *int* | ✅ | N/A | +| `item_id` | *str* | ✅ | N/A | +| `logprobs` | List[[components.StreamLogprob](../components/streamlogprob.mdx)] | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `text` | *str* | ✅ | N/A | +| `type` | [components.TextDoneEventType](../components/textdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/textextendedconfig.mdx b/docs/components/textextendedconfig.mdx index 04c08c1d7..c211e4a9f 100644 --- a/docs/components/textextendedconfig.mdx +++ b/docs/components/textextendedconfig.mdx @@ -9,5 +9,5 @@ Text output configuration including format and verbosity | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `format_` | [Optional[components.Formats]](../components/formats.mdx) | :heavy_minus_sign: | Text response format configuration | \{
"type": "text"
} | -| `verbosity` | [OptionalNullable[components.Verbosity]](../components/verbosity.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `format_` | [Optional[components.Formats]](../components/formats.mdx) | ➖ | Text response format configuration | \{
"type": "text"
} | +| `verbosity` | [OptionalNullable[components.Verbosity]](../components/verbosity.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/textgeneration.mdx b/docs/components/textgeneration.mdx index 83129fca0..5450891f9 100644 --- a/docs/components/textgeneration.mdx +++ b/docs/components/textgeneration.mdx @@ -6,6 +6,6 @@ title: "TextGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../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` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/thinkingadaptive.mdx b/docs/components/thinkingadaptive.mdx index eea8c5cd1..220914c44 100644 --- a/docs/components/thinkingadaptive.mdx +++ b/docs/components/thinkingadaptive.mdx @@ -6,6 +6,6 @@ title: "ThinkingAdaptive" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `block_binding` | [OptionalNullable[components.AnthropicThinkingBlockBinding]](../components/anthropicthinkingblockbinding.mdx) | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.mdx) | :heavy_minus_sign: | N/A | summarized | -| `type` | [components.TypeAdaptive](../components/typeadaptive.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `block_binding` | [OptionalNullable[components.AnthropicThinkingBlockBinding]](../components/anthropicthinkingblockbinding.mdx) | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.mdx) | ➖ | N/A | summarized | +| `type` | [components.TypeAdaptive](../components/typeadaptive.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/thinkingbetweentools.mdx b/docs/components/thinkingbetweentools.mdx index 52bebea40..c84e7387f 100644 --- a/docs/components/thinkingbetweentools.mdx +++ b/docs/components/thinkingbetweentools.mdx @@ -6,4 +6,4 @@ title: "ThinkingBetweenTools" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `type` | [components.TypeBetweenTools](../components/typebetweentools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.TypeBetweenTools](../components/typebetweentools.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/thinkingdisabled.mdx b/docs/components/thinkingdisabled.mdx index 5da5da387..6730aabd4 100644 --- a/docs/components/thinkingdisabled.mdx +++ b/docs/components/thinkingdisabled.mdx @@ -6,4 +6,4 @@ title: "ThinkingDisabled" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [components.ThinkingTypeDisabled](../components/thinkingtypedisabled.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.ThinkingTypeDisabled](../components/thinkingtypedisabled.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/thinkingenabled.mdx b/docs/components/thinkingenabled.mdx index 8a1bc3e1b..d5d30a46b 100644 --- a/docs/components/thinkingenabled.mdx +++ b/docs/components/thinkingenabled.mdx @@ -6,7 +6,7 @@ title: "ThinkingEnabled" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `block_binding` | [OptionalNullable[components.AnthropicThinkingBlockBinding]](../components/anthropicthinkingblockbinding.mdx) | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `budget_tokens` | *int* | :heavy_check_mark: | N/A | | -| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.mdx) | :heavy_minus_sign: | N/A | summarized | -| `type` | [components.TypeEnabled](../components/typeenabled.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `block_binding` | [OptionalNullable[components.AnthropicThinkingBlockBinding]](../components/anthropicthinkingblockbinding.mdx) | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `budget_tokens` | *int* | ✅ | N/A | | +| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.mdx) | ➖ | N/A | summarized | +| `type` | [components.TypeEnabled](../components/typeenabled.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/tokenexchangerequest.mdx b/docs/components/tokenexchangerequest.mdx index a086ed565..59182ed6a 100644 --- a/docs/components/tokenexchangerequest.mdx +++ b/docs/components/tokenexchangerequest.mdx @@ -9,9 +9,9 @@ RFC 8693 token exchange request body (application/x-www-form-urlencoded). | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `federation_policy_id` | *str* | :heavy_check_mark: | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | -| `grant_type` | [components.GrantType](../components/granttype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | -| `requested_token_type` | [Optional[components.RequestedTokenType]](../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` | [Optional[components.TokenExchangeRequestScope]](../components/tokenexchangerequestscope.mdx) | :heavy_minus_sign: | Optional; only `inference` is available. | inference | -| `subject_token` | *str* | :heavy_check_mark: | The JWT issued by your identity provider. | \ | -| `subject_token_type` | [components.SubjectTokenType](../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 +| `federation_policy_id` | *str* | ✅ | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | +| `grant_type` | [components.GrantType](../components/granttype.mdx) | ✅ | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | +| `requested_token_type` | [Optional[components.RequestedTokenType]](../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` | [Optional[components.TokenExchangeRequestScope]](../components/tokenexchangerequestscope.mdx) | ➖ | Optional; only `inference` is available. | inference | +| `subject_token` | *str* | ✅ | The JWT issued by your identity provider. | \ | +| `subject_token_type` | [components.SubjectTokenType](../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/components/tokenexchangeresponse.mdx b/docs/components/tokenexchangeresponse.mdx index c3a8de52d..9078e209e 100644 --- a/docs/components/tokenexchangeresponse.mdx +++ b/docs/components/tokenexchangeresponse.mdx @@ -9,8 +9,8 @@ RFC 8693 token exchange response. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | -| `expires_in` | *int* | :heavy_check_mark: | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | -| `issued_token_type` | [components.IssuedTokenType](../components/issuedtokentype.mdx) | :heavy_check_mark: | N/A | urn:ietf:params:oauth:token-type:access_token | -| `scope` | *str* | :heavy_check_mark: | N/A | inference | -| `token_type` | [components.TokenType](../components/tokentype.mdx) | :heavy_check_mark: | N/A | Bearer | \ No newline at end of file +| `access_token` | *str* | ✅ | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | +| `expires_in` | *int* | ✅ | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | +| `issued_token_type` | [components.IssuedTokenType](../components/issuedtokentype.mdx) | ✅ | N/A | urn:ietf:params:oauth:token-type:access_token | +| `scope` | *str* | ✅ | N/A | inference | +| `token_type` | [components.TokenType](../components/tokentype.mdx) | ✅ | N/A | Bearer | \ No newline at end of file diff --git a/docs/components/tooladvisor20260301.mdx b/docs/components/tooladvisor20260301.mdx index cf0c0f91f..76b180e20 100644 --- a/docs/components/tooladvisor20260301.mdx +++ b/docs/components/tooladvisor20260301.mdx @@ -6,11 +6,11 @@ title: "ToolAdvisor20260301" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | N/A | \{
"type": "ephemeral"
} | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `max_uses` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `name` | [components.NameAdvisor](../components/nameadvisor.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeAdvisor20260301](../components/typeadvisor20260301.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | ➖ | N/A | [
"direct"
] | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.mdx) | ➖ | N/A | \{
"type": "ephemeral"
} | +| `defer_loading` | *Optional[bool]* | ➖ | N/A | | +| `max_uses` | *Optional[int]* | ➖ | N/A | | +| `model` | *str* | ✅ | N/A | | +| `name` | [components.NameAdvisor](../components/nameadvisor.mdx) | ✅ | N/A | | +| `type` | [components.TypeAdvisor20260301](../components/typeadvisor20260301.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/toolbash20250124.mdx b/docs/components/toolbash20250124.mdx index d3a3ea6cf..222b4ee4d 100644 --- a/docs/components/toolbash20250124.mdx +++ b/docs/components/toolbash20250124.mdx @@ -6,6 +6,6 @@ title: "ToolBash20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/namebash.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeBash20250124](../components/typebash20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/namebash.mdx) | ✅ | N/A | | +| `type` | [components.TypeBash20250124](../components/typebash20250124.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/toolcall.mdx b/docs/components/toolcall.mdx index c5f4d3277..137291c48 100644 --- a/docs/components/toolcall.mdx +++ b/docs/components/toolcall.mdx @@ -6,7 +6,7 @@ title: "ToolCall" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `function` | [components.BatchObjectFunction](../components/batchobjectfunction.mdx) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ChoiceTypeFunction](../components/choicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `function` | [components.BatchObjectFunction](../components/batchobjectfunction.mdx) | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `index` | *int* | ✅ | N/A | +| `type` | [components.ChoiceTypeFunction](../components/choicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/toolchoiceallowed.mdx b/docs/components/toolchoiceallowed.mdx index 4e85322c7..364bd91bf 100644 --- a/docs/components/toolchoiceallowed.mdx +++ b/docs/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](../components/mode.mdx) | :heavy_check_mark: | N/A | -| `tools` | List[Dict[str, *Any*]] | :heavy_check_mark: | N/A | -| `type` | [components.ToolChoiceAllowedType](../components/toolchoiceallowedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `mode` | [components.Mode](../components/mode.mdx) | ✅ | N/A | +| `tools` | List[Dict[str, *Any*]] | ✅ | N/A | +| `type` | [components.ToolChoiceAllowedType](../components/toolchoiceallowedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/toolchoiceany.mdx b/docs/components/toolchoiceany.mdx index 444b70155..4909e4598 100644 --- a/docs/components/toolchoiceany.mdx +++ b/docs/components/toolchoiceany.mdx @@ -6,5 +6,5 @@ title: "ToolChoiceAny" | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `disable_parallel_tool_use` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [components.TypeAny](../components/typeany.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `disable_parallel_tool_use` | *Optional[bool]* | ➖ | N/A | +| `type` | [components.TypeAny](../components/typeany.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/toolchoiceauto.mdx b/docs/components/toolchoiceauto.mdx index 8759b2ff5..9bf6aa9d4 100644 --- a/docs/components/toolchoiceauto.mdx +++ b/docs/components/toolchoiceauto.mdx @@ -6,5 +6,5 @@ title: "ToolChoiceAuto" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `disable_parallel_tool_use` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [components.ToolChoiceTypeAuto](../components/toolchoicetypeauto.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `disable_parallel_tool_use` | *Optional[bool]* | ➖ | N/A | +| `type` | [components.ToolChoiceTypeAuto](../components/toolchoicetypeauto.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/toolchoicenone.mdx b/docs/components/toolchoicenone.mdx index a042d8988..829a82ad3 100644 --- a/docs/components/toolchoicenone.mdx +++ b/docs/components/toolchoicenone.mdx @@ -6,4 +6,4 @@ title: "ToolChoiceNone" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | [components.TypeNone](../components/typenone.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.TypeNone](../components/typenone.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/toolchoicesupport.mdx b/docs/components/toolchoicesupport.mdx index 9b95b3df7..8f260951c 100644 --- a/docs/components/toolchoicesupport.mdx +++ b/docs/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/components/toolchoicetool.mdx b/docs/components/toolchoicetool.mdx index 08139fd78..0e63411c4 100644 --- a/docs/components/toolchoicetool.mdx +++ b/docs/components/toolchoicetool.mdx @@ -6,6 +6,6 @@ title: "ToolChoiceTool" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `disable_parallel_tool_use` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TypeTool](../components/typetool.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `disable_parallel_tool_use` | *Optional[bool]* | ➖ | N/A | +| `name` | *str* | ✅ | N/A | +| `type` | [components.TypeTool](../components/typetool.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/toolcustom.mdx b/docs/components/toolcustom.mdx index a4ed39817..58127178b 100644 --- a/docs/components/toolcustom.mdx +++ b/docs/components/toolcustom.mdx @@ -6,10 +6,10 @@ title: "ToolCustom" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `input_schema` | [components.InputSchema](../components/inputschema.mdx) | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `strict` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `type` | [Optional[components.ToolTypeCustom]](../components/tooltypecustom.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `defer_loading` | *Optional[bool]* | ➖ | N/A | | +| `description` | *Optional[str]* | ➖ | N/A | | +| `input_schema` | [components.InputSchema](../components/inputschema.mdx) | ✅ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `strict` | *Optional[bool]* | ➖ | N/A | | +| `type` | [Optional[components.ToolTypeCustom]](../components/tooltypecustom.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/toolsearchcallitem.mdx b/docs/components/toolsearchcallitem.mdx index 470d130f0..b72b5f6c8 100644 --- a/docs/components/toolsearchcallitem.mdx +++ b/docs/components/toolsearchcallitem.mdx @@ -9,9 +9,9 @@ A tool search call the client executed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `arguments` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `execution` | [components.ToolSearchCallItemExecution](../components/toolsearchcallitemexecution.mdx) | :heavy_check_mark: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `status` | [OptionalNullable[components.ToolSearchCallItemStatus]](../components/toolsearchcallitemstatus.mdx) | :heavy_minus_sign: | N/A | -| `type` | [components.ToolSearchCallItemType](../components/toolsearchcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *Optional[Any]* | ➖ | N/A | +| `call_id` | *str* | ✅ | N/A | +| `execution` | [components.ToolSearchCallItemExecution](../components/toolsearchcallitemexecution.mdx) | ✅ | N/A | +| `id` | *OptionalNullable[str]* | ➖ | N/A | +| `status` | [OptionalNullable[components.ToolSearchCallItemStatus]](../components/toolsearchcallitemstatus.mdx) | ➖ | N/A | +| `type` | [components.ToolSearchCallItemType](../components/toolsearchcallitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/toolsearchoutputitem.mdx b/docs/components/toolsearchoutputitem.mdx index a5d1dd6c7..1c1e5aa84 100644 --- a/docs/components/toolsearchoutputitem.mdx +++ b/docs/components/toolsearchoutputitem.mdx @@ -9,9 +9,9 @@ The tools a client-executed tool search loaded | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `execution` | [components.ToolSearchOutputItemExecution](../components/toolsearchoutputitemexecution.mdx) | :heavy_check_mark: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `status` | [OptionalNullable[components.ToolSearchOutputItemStatus]](../components/toolsearchoutputitemstatus.mdx) | :heavy_minus_sign: | N/A | -| `tools` | List[[components.ToolSearchOutputItemToolUnion](../components/toolsearchoutputitemtoolunion.mdx)] | :heavy_check_mark: | N/A | -| `type` | [components.TypeToolSearchOutput](../components/typetoolsearchoutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `call_id` | *str* | ✅ | N/A | +| `execution` | [components.ToolSearchOutputItemExecution](../components/toolsearchoutputitemexecution.mdx) | ✅ | N/A | +| `id` | *OptionalNullable[str]* | ➖ | N/A | +| `status` | [OptionalNullable[components.ToolSearchOutputItemStatus]](../components/toolsearchoutputitemstatus.mdx) | ➖ | N/A | +| `tools` | List[[components.ToolSearchOutputItemToolUnion](../components/toolsearchoutputitemtoolunion.mdx)] | ✅ | N/A | +| `type` | [components.TypeToolSearchOutput](../components/typetoolsearchoutput.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/toolsearchoutputitemtool.mdx b/docs/components/toolsearchoutputitemtool.mdx index da5087fa6..4af6be7b4 100644 --- a/docs/components/toolsearchoutputitemtool.mdx +++ b/docs/components/toolsearchoutputitemtool.mdx @@ -6,5 +6,5 @@ title: "ToolSearchOutputItemTool" | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *str* | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *str* | ✅ | N/A | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/toolsearchoutputitemtoolfunction.mdx b/docs/components/toolsearchoutputitemtoolfunction.mdx index 49ff0552f..05cd0d061 100644 --- a/docs/components/toolsearchoutputitemtoolfunction.mdx +++ b/docs/components/toolsearchoutputitemtoolfunction.mdx @@ -9,12 +9,12 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `parameters` | Dict[str, *Any*] | :heavy_check_mark: | N/A | | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `type` | [components.ToolSearchOutputItemTypeFunction](../components/toolsearchoutputitemtypefunction.mdx) | :heavy_check_mark: | N/A | | -| `allowed_callers` | List[[components.ToolSearchOutputItemAllowedCaller](../components/toolsearchoutputitemallowedcaller.mdx)] | :heavy_minus_sign: | N/A | | -| `async_` | *Optional[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 | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | -| `output_schema` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `description` | *OptionalNullable[str]* | ➖ | N/A | | +| `name` | *str* | ✅ | N/A | | +| `parameters` | Dict[str, *Any*] | ✅ | N/A | | +| `strict` | *OptionalNullable[bool]* | ➖ | N/A | | +| `type` | [components.ToolSearchOutputItemTypeFunction](../components/toolsearchoutputitemtypefunction.mdx) | ✅ | N/A | | +| `allowed_callers` | List[[components.ToolSearchOutputItemAllowedCaller](../components/toolsearchoutputitemallowedcaller.mdx)] | ➖ | N/A | | +| `async_` | *Optional[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 | +| `defer_loading` | *Optional[bool]* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Where the request declares no search tool, OpenRouter may add `openrouter:tool_search` to serve the flag, and otherwise sends the tool in full. A request that declares the search tool itself must keep at least one tool non-deferred. | true | +| `output_schema` | Dict[str, *Any*] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/components/toolsearchservertool.mdx b/docs/components/toolsearchservertool.mdx index 4882b510c..7924f0021 100644 --- a/docs/components/toolsearchservertool.mdx +++ b/docs/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` | [Optional[components.ToolSearchServerToolConfig]](../components/toolsearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | -| `type` | [components.ToolSearchServerToolType](../components/toolsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.ToolSearchServerToolConfig]](../components/toolsearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | +| `type` | [components.ToolSearchServerToolType](../components/toolsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/toolsearchservertoolconfig.mdx b/docs/components/toolsearchservertoolconfig.mdx index f6ebf7634..4aa6b7643 100644 --- a/docs/components/toolsearchservertoolconfig.mdx +++ b/docs/components/toolsearchservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:tool_search server tool | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file +| `max_results` | *Optional[int]* | ➖ | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file diff --git a/docs/components/tooltexteditor20250124.mdx b/docs/components/tooltexteditor20250124.mdx index a7f1a2731..d12936170 100644 --- a/docs/components/tooltexteditor20250124.mdx +++ b/docs/components/tooltexteditor20250124.mdx @@ -6,6 +6,6 @@ title: "ToolTextEditor20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/namestrreplaceeditor.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeTextEditor20250124](../components/typetexteditor20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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](../components/namestrreplaceeditor.mdx) | ✅ | N/A | | +| `type` | [components.TypeTextEditor20250124](../components/typetexteditor20250124.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/toolwebsearch20250305.mdx b/docs/components/toolwebsearch20250305.mdx index 36a096412..b302ea6ff 100644 --- a/docs/components/toolwebsearch20250305.mdx +++ b/docs/components/toolwebsearch20250305.mdx @@ -6,10 +6,10 @@ title: "ToolWebSearch20250305" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | | -| `blocked_domains` | List[*str*] | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `max_uses` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `name` | [components.NameWebSearch1](../components/namewebsearch1.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeWebSearch20250305](../components/typewebsearch20250305.mdx) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../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 +| `allowed_domains` | List[*str*] | ➖ | N/A | | +| `blocked_domains` | List[*str*] | ➖ | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `max_uses` | *OptionalNullable[int]* | ➖ | N/A | | +| `name` | [components.NameWebSearch1](../components/namewebsearch1.mdx) | ✅ | N/A | | +| `type` | [components.TypeWebSearch20250305](../components/typewebsearch20250305.mdx) | ✅ | N/A | | +| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../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/components/toolwebsearch20260209.mdx b/docs/components/toolwebsearch20260209.mdx index 062b3155e..735d1d2e2 100644 --- a/docs/components/toolwebsearch20260209.mdx +++ b/docs/components/toolwebsearch20260209.mdx @@ -6,11 +6,11 @@ title: "ToolWebSearch20260209" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | | -| `blocked_domains` | List[*str*] | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | -| `max_uses` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `name` | [components.NameWebSearch2](../components/namewebsearch2.mdx) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeWebSearch20260209](../components/typewebsearch20260209.mdx) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../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 +| `allowed_callers` | List[[components.AnthropicAllowedCallers](../components/anthropicallowedcallers.mdx)] | ➖ | N/A | [
"direct"
] | +| `allowed_domains` | List[*str*] | ➖ | N/A | | +| `blocked_domains` | List[*str*] | ➖ | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../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"
} | +| `max_uses` | *OptionalNullable[int]* | ➖ | N/A | | +| `name` | [components.NameWebSearch2](../components/namewebsearch2.mdx) | ✅ | N/A | | +| `type` | [components.TypeWebSearch20260209](../components/typewebsearch20260209.mdx) | ✅ | N/A | | +| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../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/components/toomanyrequestsresponseerrordata.mdx b/docs/components/toomanyrequestsresponseerrordata.mdx index edc2b7de0..f4ef13395 100644 --- a/docs/components/toomanyrequestsresponseerrordata.mdx +++ b/docs/components/toomanyrequestsresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for TooManyRequestsResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/topproviderinfo.mdx b/docs/components/topproviderinfo.mdx index 0a324fb77..c0fb34f1a 100644 --- a/docs/components/topproviderinfo.mdx +++ b/docs/components/topproviderinfo.mdx @@ -9,6 +9,6 @@ Information about the top provider for this model | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context_length` | *OptionalNullable[int]* | :heavy_minus_sign: | Context length from the top provider | 8192 | -| `is_moderated` | *bool* | :heavy_check_mark: | Whether the top provider moderates content | true | -| `max_completion_tokens` | *OptionalNullable[int]* | :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 +| `context_length` | *OptionalNullable[int]* | ➖ | Context length from the top provider | 8192 | +| `is_moderated` | *bool* | ✅ | Whether the top provider moderates content | true | +| `max_completion_tokens` | *OptionalNullable[int]* | ➖ | 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/components/tournamentstats.mdx b/docs/components/tournamentstats.mdx index bf6cd57c5..7c4ad0cd7 100644 --- a/docs/components/tournamentstats.mdx +++ b/docs/components/tournamentstats.mdx @@ -9,8 +9,8 @@ Placement distribution from tournament matches. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `first_place` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `fourth_place` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `second_place` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `third_place` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `total` | *Nullable[int]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `first_place` | *Nullable[int]* | ✅ | N/A | +| `fourth_place` | *Nullable[int]* | ✅ | N/A | +| `second_place` | *Nullable[int]* | ✅ | N/A | +| `third_place` | *Nullable[int]* | ✅ | N/A | +| `total` | *Nullable[int]* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/traceconfig.mdx b/docs/components/traceconfig.mdx index 9dadf7654..0902a9624 100644 --- a/docs/components/traceconfig.mdx +++ b/docs/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 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `generation_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `parent_span_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `span_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `trace_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `trace_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | \ No newline at end of file +| `generation_name` | *Optional[str]* | ➖ | N/A | | +| `parent_span_id` | *Optional[str]* | ➖ | N/A | | +| `span_name` | *Optional[str]* | ➖ | N/A | | +| `trace_id` | *Optional[str]* | ➖ | N/A | | +| `trace_name` | *Optional[str]* | ➖ | N/A | | +| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | \ No newline at end of file diff --git a/docs/components/triggerinputtokens.mdx b/docs/components/triggerinputtokens.mdx index 45784f009..d117e4869 100644 --- a/docs/components/triggerinputtokens.mdx +++ b/docs/components/triggerinputtokens.mdx @@ -6,5 +6,5 @@ title: "TriggerInputTokens" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.EditTypeInputTokens](../components/edittypeinputtokens.mdx) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.EditTypeInputTokens](../components/edittypeinputtokens.mdx) | ✅ | N/A | +| `value` | *int* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/tts.mdx b/docs/components/tts.mdx index 3a4751890..29c67e43d 100644 --- a/docs/components/tts.mdx +++ b/docs/components/tts.mdx @@ -6,6 +6,6 @@ title: "TTS" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../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` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/unauthorizedresponseerrordata.mdx b/docs/components/unauthorizedresponseerrordata.mdx index ff7c1ed43..66c9721a6 100644 --- a/docs/components/unauthorizedresponseerrordata.mdx +++ b/docs/components/unauthorizedresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for UnauthorizedResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarkpricing.mdx b/docs/components/unifiedbenchmarkpricing.mdx index 322906a43..3e86f72aa 100644 --- a/docs/components/unifiedbenchmarkpricing.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | Cost per output token (USD, decimal string). | 0.000015 | -| `prompt` | *str* | :heavy_check_mark: | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file +| `completion` | *str* | ✅ | Cost per output token (USD, decimal string). | 0.000015 | +| `prompt` | *str* | ✅ | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksaaitem.mdx b/docs/components/unifiedbenchmarksaaitem.mdx index 0a22591fe..ed664fe34 100644 --- a/docs/components/unifiedbenchmarksaaitem.mdx +++ b/docs/components/unifiedbenchmarksaaitem.mdx @@ -6,10 +6,10 @@ title: "UnifiedBenchmarksAAItem" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `agentic_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | -| `coding_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | -| `display_name` | *str* | :heavy_check_mark: | Model name as listed on Artificial Analysis. | GPT-4o | -| `intelligence_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | -| `model_permaslug` | *str* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `pricing` | [Nullable[components.UnifiedBenchmarkPricing]](../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](../components/unifiedbenchmarksaaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | \ No newline at end of file +| `agentic_index` | *Nullable[float]* | ✅ | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | +| `coding_index` | *Nullable[float]* | ✅ | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | +| `display_name` | *str* | ✅ | Model name as listed on Artificial Analysis. | GPT-4o | +| `intelligence_index` | *Nullable[float]* | ✅ | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | +| `model_permaslug` | *str* | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | +| `pricing` | [Nullable[components.UnifiedBenchmarkPricing]](../components/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `source` | [components.UnifiedBenchmarksAAItemSource](../components/unifiedbenchmarksaaitemsource.mdx) | ✅ | Benchmark source discriminator. | | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksdaitem.mdx b/docs/components/unifiedbenchmarksdaitem.mdx index 95f66134b..3f3b5c777 100644 --- a/docs/components/unifiedbenchmarksdaitem.mdx +++ b/docs/components/unifiedbenchmarksdaitem.mdx @@ -6,13 +6,13 @@ title: "UnifiedBenchmarksDAItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `arena` | *str* | :heavy_check_mark: | Arena this ranking belongs to. | models | -| `avg_generation_time_ms` | *Nullable[float]* | :heavy_check_mark: | Average generation time in milliseconds. | 3200 | -| `category` | *str* | :heavy_check_mark: | Category within the arena. | codecategories | -| `display_name` | *str* | :heavy_check_mark: | Human-readable model name from Design Arena. | Claude Sonnet 4 | -| `elo` | *float* | :heavy_check_mark: | ELO rating from head-to-head arena battles. | 1423 | -| `model_permaslug` | *str* | :heavy_check_mark: | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | -| `pricing` | [Nullable[components.UnifiedBenchmarkPricing]](../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](../components/unifiedbenchmarksdaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `tournament_stats` | [components.TournamentStats](../components/tournamentstats.mdx) | :heavy_check_mark: | Placement distribution from tournament matches. | | -| `win_rate` | *float* | :heavy_check_mark: | Win rate as a percentage (0–100). | 72 | \ No newline at end of file +| `arena` | *str* | ✅ | Arena this ranking belongs to. | models | +| `avg_generation_time_ms` | *Nullable[float]* | ✅ | Average generation time in milliseconds. | 3200 | +| `category` | *str* | ✅ | Category within the arena. | codecategories | +| `display_name` | *str* | ✅ | Human-readable model name from Design Arena. | Claude Sonnet 4 | +| `elo` | *float* | ✅ | ELO rating from head-to-head arena battles. | 1423 | +| `model_permaslug` | *str* | ✅ | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | +| `pricing` | [Nullable[components.UnifiedBenchmarkPricing]](../components/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `source` | [components.UnifiedBenchmarksDAItemSource](../components/unifiedbenchmarksdaitemsource.mdx) | ✅ | Benchmark source discriminator. | | +| `tournament_stats` | [components.TournamentStats](../components/tournamentstats.mdx) | ✅ | Placement distribution from tournament matches. | | +| `win_rate` | *float* | ✅ | Win rate as a percentage (0–100). | 72 | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksmeta.mdx b/docs/components/unifiedbenchmarksmeta.mdx index ea52df6e0..b68e72df2 100644 --- a/docs/components/unifiedbenchmarksmeta.mdx +++ b/docs/components/unifiedbenchmarksmeta.mdx @@ -6,10 +6,10 @@ title: "UnifiedBenchmarksMeta" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `as_of` | *str* | :heavy_check_mark: | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | -| `citation` | *Nullable[str]* | :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). | -| `model_count` | *int* | :heavy_check_mark: | Number of unique models in the response. | | -| `source` | [Nullable[components.UnifiedBenchmarksMetaSource]](../components/unifiedbenchmarksmetasource.mdx) | :heavy_check_mark: | The source filter applied, or null when all sources are returned. | artificial-analysis | -| `source_url` | *Nullable[str]* | :heavy_check_mark: | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | -| `task_type` | *Nullable[str]* | :heavy_check_mark: | The task_type filter applied, or null if showing all. | | -| `version` | [components.UnifiedBenchmarksMetaVersion](../components/unifiedbenchmarksmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | \ No newline at end of file +| `as_of` | *str* | ✅ | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | +| `citation` | *Nullable[str]* | ✅ | 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). | +| `model_count` | *int* | ✅ | Number of unique models in the response. | | +| `source` | [Nullable[components.UnifiedBenchmarksMetaSource]](../components/unifiedbenchmarksmetasource.mdx) | ✅ | The source filter applied, or null when all sources are returned. | artificial-analysis | +| `source_url` | *Nullable[str]* | ✅ | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | +| `task_type` | *Nullable[str]* | ✅ | The task_type filter applied, or null if showing all. | | +| `version` | [components.UnifiedBenchmarksMetaVersion](../components/unifiedbenchmarksmetaversion.mdx) | ✅ | Dataset version. | | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksoritem.mdx b/docs/components/unifiedbenchmarksoritem.mdx index ec2f59459..2132c22ef 100644 --- a/docs/components/unifiedbenchmarksoritem.mdx +++ b/docs/components/unifiedbenchmarksoritem.mdx @@ -6,12 +6,12 @@ title: "UnifiedBenchmarksORItem" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `accuracy` | *float* | :heavy_check_mark: | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | -| `accuracy_stddev` | *Nullable[float]* | :heavy_check_mark: | Standard deviation of run accuracy, or null for a single run. | 0.03 | -| `avg_cost_per_task` | *Nullable[float]* | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.002 | -| `benchmark_type` | [components.UnifiedBenchmarksORItemBenchmarkType](../components/unifiedbenchmarksoritembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter benchmark evaluation type. | gpqa_diamond | -| `display_name` | *str* | :heavy_check_mark: | Human-readable model name. | GPT-4o | -| `last_run_timestamp` | *str* | :heavy_check_mark: | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | -| `model_permaslug` | *str* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `source` | [components.UnifiedBenchmarksORItemSource](../components/unifiedbenchmarksoritemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `total_tasks` | *int* | :heavy_check_mark: | Total benchmark tasks across runs. | 300 | \ No newline at end of file +| `accuracy` | *float* | ✅ | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | +| `accuracy_stddev` | *Nullable[float]* | ✅ | Standard deviation of run accuracy, or null for a single run. | 0.03 | +| `avg_cost_per_task` | *Nullable[float]* | ✅ | Average cost per task in USD, or null if unavailable. | 0.002 | +| `benchmark_type` | [components.UnifiedBenchmarksORItemBenchmarkType](../components/unifiedbenchmarksoritembenchmarktype.mdx) | ✅ | OpenRouter benchmark evaluation type. | gpqa_diamond | +| `display_name` | *str* | ✅ | Human-readable model name. | GPT-4o | +| `last_run_timestamp` | *str* | ✅ | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | +| `model_permaslug` | *str* | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | +| `source` | [components.UnifiedBenchmarksORItemSource](../components/unifiedbenchmarksoritemsource.mdx) | ✅ | Benchmark source discriminator. | | +| `total_tasks` | *int* | ✅ | Total benchmark tasks across runs. | 300 | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarksresponse.mdx b/docs/components/unifiedbenchmarksresponse.mdx index ee48e6457..acfc1a88d 100644 --- a/docs/components/unifiedbenchmarksresponse.mdx +++ b/docs/components/unifiedbenchmarksresponse.mdx @@ -6,5 +6,5 @@ title: "UnifiedBenchmarksResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.UnifiedBenchmarksResponseData](../components/unifiedbenchmarksresponsedata.mdx)] | :heavy_check_mark: | N/A | | -| `meta` | [components.UnifiedBenchmarksMeta](../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` | List[[components.UnifiedBenchmarksResponseData](../components/unifiedbenchmarksresponsedata.mdx)] | ✅ | N/A | | +| `meta` | [components.UnifiedBenchmarksMeta](../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/components/unifiedbenchmarkssearchitem.mdx b/docs/components/unifiedbenchmarkssearchitem.mdx index 40b4f0bea..431e9d9da 100644 --- a/docs/components/unifiedbenchmarkssearchitem.mdx +++ b/docs/components/unifiedbenchmarkssearchitem.mdx @@ -6,16 +6,16 @@ title: "UnifiedBenchmarksSearchItem" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `avg_cost_per_task` | *Nullable[float]* | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.031 | -| `avg_latency_per_task_ms` | *Nullable[float]* | :heavy_check_mark: | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | -| `benchmark_type` | [components.UnifiedBenchmarksSearchItemBenchmarkType](../components/unifiedbenchmarkssearchitembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter search benchmark. | search_browsecomp | -| `display_name` | *str* | :heavy_check_mark: | Human-readable model name. | GPT-4o | -| `last_run_timestamp` | *str* | :heavy_check_mark: | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | -| `model_permaslug` | *str* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `primary_metric` | [components.PrimaryMetric](../components/primarymetric.mdx) | :heavy_check_mark: | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | -| `primary_score` | *float* | :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 | -| `run_config` | [Optional[components.UnifiedBenchmarksSearchRunConfig]](../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. | | -| `search_engine` | *str* | :heavy_check_mark: | Search engine the published configuration used. | exa | -| `search_surface` | [components.SearchSurface](../components/searchsurface.mdx) | :heavy_check_mark: | Request surface the published configuration went through. | server-tool | -| `source` | [components.UnifiedBenchmarksSearchItemSource](../components/unifiedbenchmarkssearchitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `total_tasks` | *int* | :heavy_check_mark: | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file +| `avg_cost_per_task` | *Nullable[float]* | ✅ | Average cost per task in USD, or null if unavailable. | 0.031 | +| `avg_latency_per_task_ms` | *Nullable[float]* | ✅ | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | +| `benchmark_type` | [components.UnifiedBenchmarksSearchItemBenchmarkType](../components/unifiedbenchmarkssearchitembenchmarktype.mdx) | ✅ | OpenRouter search benchmark. | search_browsecomp | +| `display_name` | *str* | ✅ | Human-readable model name. | GPT-4o | +| `last_run_timestamp` | *str* | ✅ | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | +| `model_permaslug` | *str* | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | +| `primary_metric` | [components.PrimaryMetric](../components/primarymetric.mdx) | ✅ | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | +| `primary_score` | *float* | ✅ | 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 | +| `run_config` | [Optional[components.UnifiedBenchmarksSearchRunConfig]](../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. | | +| `search_engine` | *str* | ✅ | Search engine the published configuration used. | exa | +| `search_surface` | [components.SearchSurface](../components/searchsurface.mdx) | ✅ | Request surface the published configuration went through. | server-tool | +| `source` | [components.UnifiedBenchmarksSearchItemSource](../components/unifiedbenchmarkssearchitemsource.mdx) | ✅ | Benchmark source discriminator. | | +| `total_tasks` | *int* | ✅ | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file diff --git a/docs/components/unifiedbenchmarkssearchrunconfig.mdx b/docs/components/unifiedbenchmarkssearchrunconfig.mdx index 21f463fd8..e4872e0ba 100644 --- a/docs/components/unifiedbenchmarkssearchrunconfig.mdx +++ b/docs/components/unifiedbenchmarkssearchrunconfig.mdx @@ -9,6 +9,6 @@ Published lane configuration, included only when include_run_config=true. Only t | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `max_agent_turns` | *Nullable[int]* | :heavy_check_mark: | Agent-turn count for the published lane, or null for plugin lanes. | 25 | -| `reasoning_effort` | *Nullable[str]* | :heavy_check_mark: | Reasoning effort configured for the published lane, or null when omitted. | high | -| `temperature` | *Nullable[float]* | :heavy_check_mark: | Sampling temperature configured for the published lane, or null when omitted. | 0.2 | \ No newline at end of file +| `max_agent_turns` | *Nullable[int]* | ✅ | Agent-turn count for the published lane, or null for plugin lanes. | 25 | +| `reasoning_effort` | *Nullable[str]* | ✅ | Reasoning effort configured for the published lane, or null when omitted. | high | +| `temperature` | *Nullable[float]* | ✅ | Sampling temperature configured for the published lane, or null when omitted. | 0.2 | \ No newline at end of file diff --git a/docs/components/uniqueinsight.mdx b/docs/components/uniqueinsight.mdx index 2dd2e0e31..eea1ee281 100644 --- a/docs/components/uniqueinsight.mdx +++ b/docs/components/uniqueinsight.mdx @@ -6,5 +6,5 @@ title: "UniqueInsight" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `insight` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `insight` | *str* | ✅ | N/A | +| `model` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/unknown.mdx b/docs/components/unknown.mdx index 77c502f0a..a15b82456 100644 --- a/docs/components/unknown.mdx +++ b/docs/components/unknown.mdx @@ -6,6 +6,6 @@ title: "Unknown" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../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` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/unprocessableentityresponseerrordata.mdx b/docs/components/unprocessableentityresponseerrordata.mdx index 5a7e1816a..423b9c7a9 100644 --- a/docs/components/unprocessableentityresponseerrordata.mdx +++ b/docs/components/unprocessableentityresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for UnprocessableEntityResponse | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *int* | ✅ | N/A | +| `message` | *str* | ✅ | N/A | +| `metadata` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/updatebyokkeyrequest.mdx b/docs/components/updatebyokkeyrequest.mdx index a9c7eb201..a8bef74c3 100644 --- a/docs/components/updatebyokkeyrequest.mdx +++ b/docs/components/updatebyokkeyrequest.mdx @@ -6,14 +6,14 @@ title: "UpdateBYOKKeyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_api_key_hashes` | List[*str*] | :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"
] | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declared_region` | [OptionalNullable[components.UpdateBYOKKeyRequestDeclaredRegion]](../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 | -| `declared_zdr` | *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential is disabled. | false | -| `is_byok_only` | *Optional[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 | -| `is_fallback` | *Optional[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 | -| `is_required` | *Optional[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` | *Optional[str]* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file +| `allowed_api_key_hashes` | List[*str*] | ➖ | 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"
] | +| `allowed_models` | List[*str*] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declared_region` | [OptionalNullable[components.UpdateBYOKKeyRequestDeclaredRegion]](../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 | +| `declared_zdr` | *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` | *Optional[bool]* | ➖ | Whether this credential is disabled. | false | +| `is_byok_only` | *Optional[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 | +| `is_fallback` | *Optional[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 | +| `is_required` | *Optional[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` | *Optional[str]* | ➖ | 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[str]* | ➖ | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file diff --git a/docs/components/updatebyokkeyresponse.mdx b/docs/components/updatebyokkeyresponse.mdx index b1eafbef0..4249563ec 100644 --- a/docs/components/updatebyokkeyresponse.mdx +++ b/docs/components/updatebyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.BYOKKey](../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](../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/components/updateenduserrequest.mdx b/docs/components/updateenduserrequest.mdx index 72a1c5ade..4454ea375 100644 --- a/docs/components/updateenduserrequest.mdx +++ b/docs/components/updateenduserrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateEndUserRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `is_active` | *bool* | :heavy_check_mark: | Registration state only; does not enforce inference access. | true | \ No newline at end of file +| `is_active` | *bool* | ✅ | Registration state only; does not enforce inference access. | true | \ No newline at end of file diff --git a/docs/components/updateguardrailrequest.mdx b/docs/components/updateguardrailrequest.mdx index dfd991a99..8b1df60e8 100644 --- a/docs/components/updateguardrailrequest.mdx +++ b/docs/components/updateguardrailrequest.mdx @@ -6,25 +6,25 @@ title: "UpdateGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | false | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the guardrail | Updated description | -| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`enforce_zdr`~~ | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit in USD | 75 | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file +| `allow_safety_retention_google` | *OptionalNullable[bool]* | ➖ | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | false | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../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"
] | +| `allowed_models` | List[*str*] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | +| `allowed_providers` | List[*str*] | ➖ | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../components/contentfilterentry.mdx)] | ➖ | Custom regex content filters to apply. Set to null to remove. | null | +| `description` | *OptionalNullable[str]* | ➖ | New description for the guardrail | Updated description | +| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`enforce_zdr`~~ | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | +| `ignored_models` | List[*str*] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *OptionalNullable[float]* | ➖ | New spending limit in USD | 75 | +| `name` | *Optional[str]* | ➖ | New name for the guardrail | Updated Guardrail Name | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file diff --git a/docs/components/updateguardrailresponse.mdx b/docs/components/updateguardrailresponse.mdx index 510bac097..3cfd101fd 100644 --- a/docs/components/updateguardrailresponse.mdx +++ b/docs/components/updateguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Guardrail](../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](../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/components/updateinternrequest.mdx b/docs/components/updateinternrequest.mdx index cd20dcfbb..423c25040 100644 --- a/docs/components/updateinternrequest.mdx +++ b/docs/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[str]* | :heavy_minus_sign: | New free-form description. Null clears it. | -| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | New standing instructions. Null clears them. | -| `model` | *OptionalNullable[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | New intern name, unique per creator within the workspace. | \ No newline at end of file +| `description` | *OptionalNullable[str]* | ➖ | New free-form description. Null clears it. | +| `instructions` | *OptionalNullable[str]* | ➖ | New standing instructions. Null clears them. | +| `model` | *OptionalNullable[str]* | ➖ | 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` | *Optional[str]* | ➖ | New intern name, unique per creator within the workspace. | \ No newline at end of file diff --git a/docs/components/updateobservabilitydestinationrequest.mdx b/docs/components/updateobservabilitydestinationrequest.mdx index af5a61e64..2ea89116a 100644 --- a/docs/components/updateobservabilitydestinationrequest.mdx +++ b/docs/components/updateobservabilitydestinationrequest.mdx @@ -6,15 +6,15 @@ title: "UpdateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *Optional[bool]* | :heavy_minus_sign: | Whether to include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *Optional[bool]* | :heavy_minus_sign: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *Optional[bool]* | :heavy_minus_sign: | Whether to include identity generation metadata. | false | -| `broadcast_generation_request_context` | *Optional[bool]* | :heavy_minus_sign: | Whether to include request-context generation metadata. | false | -| `config` | Dict[str, *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` | *Optional[bool]* | :heavy_minus_sign: | Whether the destination is enabled. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../components/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | N/A | null | -| `name` | *Optional[str]* | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegionInput](../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"
] | -| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file +| `api_key_hashes` | List[*str*] | ➖ | 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 | +| `broadcast_generation_cost` | *Optional[bool]* | ➖ | Whether to include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *Optional[bool]* | ➖ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *Optional[bool]* | ➖ | Whether to include identity generation metadata. | false | +| `broadcast_generation_request_context` | *Optional[bool]* | ➖ | Whether to include request-context generation metadata. | false | +| `config` | Dict[str, *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` | *Optional[bool]* | ➖ | Whether the destination is enabled. | true | +| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../components/observabilityfilterrulesconfignullable.mdx) | ➖ | N/A | null | +| `name` | *Optional[str]* | ➖ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *Optional[bool]* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegionInput](../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"
] | +| `sampling_rate` | *Optional[float]* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file diff --git a/docs/components/updateobservabilitydestinationresponse.mdx b/docs/components/updateobservabilitydestinationresponse.mdx index 7c7ec75d1..8104fe2ea 100644 --- a/docs/components/updateobservabilitydestinationresponse.mdx +++ b/docs/components/updateobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ObservabilityDestination](../components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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](../components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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/components/updateorganizationsettingsrequest.mdx b/docs/components/updateorganizationsettingsrequest.mdx index d46fb370c..81d790790 100644 --- a/docs/components/updateorganizationsettingsrequest.mdx +++ b/docs/components/updateorganizationsettingsrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateOrganizationSettingsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is_filtered_model_catalog_enabled` | *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 +| `is_filtered_model_catalog_enabled` | *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/components/updateprivateendpointpricingrequest.mdx b/docs/components/updateprivateendpointpricingrequest.mdx index 96fbfd329..1f7652eaa 100644 --- a/docs/components/updateprivateendpointpricingrequest.mdx +++ b/docs/components/updateprivateendpointpricingrequest.mdx @@ -6,4 +6,4 @@ title: "UpdatePrivateEndpointPricingRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `pricing` | [components.PrivateEndpointPricing](../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](../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/components/updateprivateendpointrequest.mdx b/docs/components/updateprivateendpointrequest.mdx index ea23134f7..850b32735 100644 --- a/docs/components/updateprivateendpointrequest.mdx +++ b/docs/components/updateprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "UpdatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `base_url` | *Optional[str]* | :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 | -| `declared_region` | [OptionalNullable[components.UpdatePrivateEndpointRequestDeclaredRegion]](../components/updateprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | -| `declared_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | -| `upstream_model_id` | *str* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `base_url` | *Optional[str]* | ➖ | 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 | +| `declared_region` | [OptionalNullable[components.UpdatePrivateEndpointRequestDeclaredRegion]](../components/updateprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | +| `declared_zdr` | *OptionalNullable[bool]* | ➖ | Attest that this deployment retains no prompt or completion data. | | +| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/components/updatescimgroupmappingrequest.mdx b/docs/components/updatescimgroupmappingrequest.mdx index 8206d9182..a3bc0914e 100644 --- a/docs/components/updatescimgroupmappingrequest.mdx +++ b/docs/components/updatescimgroupmappingrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateScimGroupMappingRequest" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `role` | [components.UpdateScimGroupMappingRequestRole](../components/updatescimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `role` | [components.UpdateScimGroupMappingRequestRole](../components/updatescimgroupmappingrequestrole.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/updatescimgroupmappingresponse.mdx b/docs/components/updatescimgroupmappingresponse.mdx index 651230ce1..c247528ea 100644 --- a/docs/components/updatescimgroupmappingresponse.mdx +++ b/docs/components/updatescimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ScimGroupMapping](../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](../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/components/updateworkspacerequest.mdx b/docs/components/updateworkspacerequest.mdx index d0d068f60..d7ddcb804 100644 --- a/docs/components/updateworkspacerequest.mdx +++ b/docs/components/updateworkspacerequest.mdx @@ -6,15 +6,15 @@ title: "UpdateWorkspaceRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the workspace | Updated description | -| `disabled_server_tools` | List[[components.UpdateWorkspaceRequestDisabledServerTool](../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"
] | -| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | -| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the workspace | Updated Workspace | -| `slug` | *Optional[str]* | :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 +| `default_image_model` | *OptionalNullable[str]* | ➖ | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *OptionalNullable[str]* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *OptionalNullable[str]* | ➖ | Default text model for this workspace | openai/gpt-4o | +| `description` | *OptionalNullable[str]* | ➖ | New description for the workspace | Updated description | +| `disabled_server_tools` | List[[components.UpdateWorkspaceRequestDisabledServerTool](../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"
] | +| `io_logging_api_key_ids` | List[*int*] | ➖ | Optional array of API key IDs to filter I/O logging | null | +| `io_logging_sampling_rate` | *Optional[float]* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | +| `is_data_discount_logging_enabled` | *Optional[bool]* | ➖ | Whether data discount logging is enabled | true | +| `is_observability_broadcast_enabled` | *Optional[bool]* | ➖ | Whether broadcast is enabled | false | +| `is_observability_io_logging_enabled` | *Optional[bool]* | ➖ | Whether private logging is enabled | false | +| `name` | *Optional[str]* | ➖ | New name for the workspace | Updated Workspace | +| `slug` | *Optional[str]* | ➖ | 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/components/updateworkspaceresponse.mdx b/docs/components/updateworkspaceresponse.mdx index bb50c7c71..4c757827f 100644 --- a/docs/components/updateworkspaceresponse.mdx +++ b/docs/components/updateworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Workspace](../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](../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/components/upscalefactor.mdx b/docs/components/upscalefactor.mdx index 8ab4fef86..3bb35a91f 100644 --- a/docs/components/upscalefactor.mdx +++ b/docs/components/upscalefactor.mdx @@ -9,5 +9,5 @@ Supported upscale factor range for video upscaling models | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `max` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `min` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `max` | *OptionalNullable[float]* | ➖ | N/A | +| `min` | *OptionalNullable[float]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/upsertworkspacebudgetrequest.mdx b/docs/components/upsertworkspacebudgetrequest.mdx index 7417e0844..ce00aab13 100644 --- a/docs/components/upsertworkspacebudgetrequest.mdx +++ b/docs/components/upsertworkspacebudgetrequest.mdx @@ -6,5 +6,5 @@ title: "UpsertWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *float* | :heavy_check_mark: | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *float* | ✅ | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file diff --git a/docs/components/upsertworkspacebudgetresponse.mdx b/docs/components/upsertworkspacebudgetresponse.mdx index 20e9f498c..0a23c5a79 100644 --- a/docs/components/upsertworkspacebudgetresponse.mdx +++ b/docs/components/upsertworkspacebudgetresponse.mdx @@ -6,5 +6,5 @@ title: "UpsertWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.WorkspaceBudget](../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"
} | -| `include_byok_in_budgets` | *Optional[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](../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"
} | +| `include_byok_in_budgets` | *Optional[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/components/upstream.mdx b/docs/components/upstream.mdx index 961a07704..69d8b821b 100644 --- a/docs/components/upstream.mdx +++ b/docs/components/upstream.mdx @@ -9,5 +9,5 @@ The upstream batch deletion outcome; omitted when no provider was assigned. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `provider` | *str* | :heavy_check_mark: | The provider name stored on the batch. | OpenAI | -| `status` | [components.BatchDeletionOutcome](../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` | *str* | ✅ | The provider name stored on the batch. | OpenAI | +| `status` | [components.BatchDeletionOutcome](../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/components/urlcitation.mdx b/docs/components/urlcitation.mdx index 0386b33d8..d23353c99 100644 --- a/docs/components/urlcitation.mdx +++ b/docs/components/urlcitation.mdx @@ -6,9 +6,9 @@ title: "URLCitation" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.URLCitationType](../components/urlcitationtype.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *Optional[str]* | ➖ | N/A | +| `end_index` | *int* | ✅ | N/A | +| `start_index` | *int* | ✅ | N/A | +| `title` | *str* | ✅ | N/A | +| `type` | [components.URLCitationType](../components/urlcitationtype.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/usage.mdx b/docs/components/usage.mdx index bdccd1463..3aa98f3a9 100644 --- a/docs/components/usage.mdx +++ b/docs/components/usage.mdx @@ -6,12 +6,12 @@ title: "Usage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `input_tokens` | *int* | :heavy_check_mark: | N/A | | -| `input_tokens_details` | [components.InputTokensDetails](../components/inputtokensdetails.mdx) | :heavy_check_mark: | N/A | | -| `output_tokens` | *int* | :heavy_check_mark: | N/A | | -| `output_tokens_details` | [components.OutputTokensDetails](../components/outputtokensdetails.mdx) | :heavy_check_mark: | N/A | | -| `total_tokens` | *int* | :heavy_check_mark: | N/A | | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | -| `cost_details` | [Optional[components.UsageCostDetails]](../components/usagecostdetails.mdx) | :heavy_minus_sign: | N/A | | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `server_tool_use_details` | [OptionalNullable[components.ServerToolUseDetails]](../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 +| `input_tokens` | *int* | ✅ | N/A | | +| `input_tokens_details` | [components.InputTokensDetails](../components/inputtokensdetails.mdx) | ✅ | N/A | | +| `output_tokens` | *int* | ✅ | N/A | | +| `output_tokens_details` | [components.OutputTokensDetails](../components/outputtokensdetails.mdx) | ✅ | N/A | | +| `total_tokens` | *int* | ✅ | N/A | | +| `cost` | *OptionalNullable[float]* | ➖ | Cost of the completion | | +| `cost_details` | [Optional[components.UsageCostDetails]](../components/usagecostdetails.mdx) | ➖ | N/A | | +| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `server_tool_use_details` | [OptionalNullable[components.ServerToolUseDetails]](../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/components/usagecostdetails.mdx b/docs/components/usagecostdetails.mdx index f7efeafac..508e844be 100644 --- a/docs/components/usagecostdetails.mdx +++ b/docs/components/usagecostdetails.mdx @@ -6,7 +6,7 @@ title: "UsageCostDetails" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `server_tool_cost` | *OptionalNullable[float]* | :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. | -| `upstream_inference_cost` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `upstream_inference_input_cost` | *float* | :heavy_check_mark: | N/A | -| `upstream_inference_output_cost` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file +| `server_tool_cost` | *OptionalNullable[float]* | ➖ | 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. | +| `upstream_inference_cost` | *OptionalNullable[float]* | ➖ | N/A | +| `upstream_inference_input_cost` | *float* | ✅ | N/A | +| `upstream_inference_output_cost` | *float* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/userlocation.mdx b/docs/components/userlocation.mdx index 2b1814dbe..6aed589dc 100644 --- a/docs/components/userlocation.mdx +++ b/docs/components/userlocation.mdx @@ -9,8 +9,8 @@ Approximate user location for location-biased search results. Passed through to | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.WebSearchPluginType](../components/websearchplugintype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | ➖ | N/A | +| `country` | *OptionalNullable[str]* | ➖ | N/A | +| `region` | *OptionalNullable[str]* | ➖ | N/A | +| `timezone` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [components.WebSearchPluginType](../components/websearchplugintype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/validateprivateendpointrequest.mdx b/docs/components/validateprivateendpointrequest.mdx index d41a02a62..096c78fc9 100644 --- a/docs/components/validateprivateendpointrequest.mdx +++ b/docs/components/validateprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "ValidatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `workspace_id` | *str* | :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 +| `workspace_id` | *str* | ✅ | 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/components/vaulteffectivesecret.mdx b/docs/components/vaulteffectivesecret.mdx index 54d681fca..7fd9791a5 100644 --- a/docs/components/vaulteffectivesecret.mdx +++ b/docs/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 | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | -| `fingerprint` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `hosts` | List[*str*] | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `scope` | [components.VaultEffectiveSecretScope](../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 +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | N/A | +| `fingerprint` | *Nullable[str]* | ✅ | N/A | +| `hosts` | List[*str*] | ✅ | N/A | +| `name` | *str* | ✅ | N/A | +| `scope` | [components.VaultEffectiveSecretScope](../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/components/vaulteffectivesecretlistresponse.mdx b/docs/components/vaulteffectivesecretlistresponse.mdx index 84fe50a0b..e9e7dcc60 100644 --- a/docs/components/vaulteffectivesecretlistresponse.mdx +++ b/docs/components/vaulteffectivesecretlistresponse.mdx @@ -9,5 +9,5 @@ One page of the secrets an intern receives, one entry per name. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.VaultEffectiveSecret](../components/vaulteffectivesecret.mdx)] | :heavy_check_mark: | N/A | -| `has_more` | *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` | List[[components.VaultEffectiveSecret](../components/vaulteffectivesecret.mdx)] | ✅ | N/A | +| `has_more` | *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/components/vaultsecret.mdx b/docs/components/vaultsecret.mdx index 912186ec2..d001e0188 100644 --- a/docs/components/vaultsecret.mdx +++ b/docs/components/vaultsecret.mdx @@ -9,7 +9,7 @@ Metadata for one stored secret. The secret value is never returned. `fingerprint | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | -| `fingerprint` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `hosts` | List[*str*] | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | N/A | +| `fingerprint` | *Nullable[str]* | ✅ | N/A | +| `hosts` | List[*str*] | ✅ | N/A | +| `name` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/vaultsecretcopyrequest.mdx b/docs/components/vaultsecretcopyrequest.mdx index 78fb27510..887a6dca6 100644 --- a/docs/components/vaultsecretcopyrequest.mdx +++ b/docs/components/vaultsecretcopyrequest.mdx @@ -9,4 +9,4 @@ Workspace secrets to copy into the intern scope. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `names` | List[*str*] | :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` | List[*str*] | ✅ | 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/components/vaultsecretcopyresponse.mdx b/docs/components/vaultsecretcopyresponse.mdx index 60ce995cb..125157afe 100644 --- a/docs/components/vaultsecretcopyresponse.mdx +++ b/docs/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` | List[[components.VaultSecret](../components/vaultsecret.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.VaultSecret](../components/vaultsecret.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/vaultsecretlistresponse.mdx b/docs/components/vaultsecretlistresponse.mdx index 0b17bf589..f769e3916 100644 --- a/docs/components/vaultsecretlistresponse.mdx +++ b/docs/components/vaultsecretlistresponse.mdx @@ -9,5 +9,5 @@ One page of secret metadata for the selected scope. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.VaultSecret](../components/vaultsecret.mdx)] | :heavy_check_mark: | N/A | -| `has_more` | *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` | List[[components.VaultSecret](../components/vaultsecret.mdx)] | ✅ | N/A | +| `has_more` | *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/components/vaultsecretresponse.mdx b/docs/components/vaultsecretresponse.mdx index db67f3cfa..5aedbf0e6 100644 --- a/docs/components/vaultsecretresponse.mdx +++ b/docs/components/vaultsecretresponse.mdx @@ -9,4 +9,4 @@ Metadata for the stored secret. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.VaultSecret](../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](../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/components/vaultsecretwriterequest.mdx b/docs/components/vaultsecretwriterequest.mdx index 92dcbeadd..b0b3328ad 100644 --- a/docs/components/vaultsecretwriterequest.mdx +++ b/docs/components/vaultsecretwriterequest.mdx @@ -9,5 +9,5 @@ Secret value and the exact hostnames it may be released to. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hosts` | List[*str*] | :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` | *str* | :heavy_check_mark: | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | \ No newline at end of file +| `hosts` | List[*str*] | ✅ | 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` | *str* | ✅ | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | \ No newline at end of file diff --git a/docs/components/videogeneration.mdx b/docs/components/videogeneration.mdx index 0f7cc13e2..482122145 100644 --- a/docs/components/videogeneration.mdx +++ b/docs/components/videogeneration.mdx @@ -6,6 +6,6 @@ title: "VideoGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `latency` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `request_count` | *Nullable[int]* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [Nullable[components.PercentileStats]](../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` | [Nullable[components.PercentileStats]](../components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `request_count` | *Nullable[int]* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [Nullable[components.PercentileStats]](../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/components/videogenerationrequest.mdx b/docs/components/videogenerationrequest.mdx index 8f8569b74..41b9387f7 100644 --- a/docs/components/videogenerationrequest.mdx +++ b/docs/components/videogenerationrequest.mdx @@ -6,21 +6,21 @@ title: "VideoGenerationRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aspect_ratio` | [Optional[components.VideoGenerationRequestAspectRatio]](../components/videogenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | -| `callback_url` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | -| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | -| `frame_images` | List[[components.FrameImage](../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. | | -| `generate_audio` | *Optional[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 | -| `input_references` | List[[components.InputReference](../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` | *str* | :heavy_check_mark: | N/A | | -| `previous_job_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | [Optional[components.VideoGenerationRequestProvider]](../components/videogenerationrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `resolution` | [Optional[components.VideoGenerationRequestResolution]](../components/videogenerationrequestresolution.mdx) | :heavy_minus_sign: | Resolution of the generated video | 720p | -| `seed` | *Optional[int]* | :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. | | -| `session_id` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | -| `trace` | [Optional[components.TraceConfig]](../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"
} | -| `upscale_factor` | *Optional[float]* | :heavy_minus_sign: | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | -| `user` | *Optional[str]* | :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 +| `aspect_ratio` | [Optional[components.VideoGenerationRequestAspectRatio]](../components/videogenerationrequestaspectratio.mdx) | ➖ | Aspect ratio of the generated video | 16:9 | +| `callback_url` | *Optional[str]* | ➖ | 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` | *Optional[int]* | ➖ | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | +| `duration` | *Optional[int]* | ➖ | Duration of the generated video in seconds | 8 | +| `frame_images` | List[[components.FrameImage](../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. | | +| `generate_audio` | *Optional[bool]* | ➖ | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | +| `input_references` | List[[components.InputReference](../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` | *str* | ✅ | N/A | | +| `previous_job_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.VideoGenerationRequestProvider]](../components/videogenerationrequestprovider.mdx) | ➖ | Provider-specific passthrough configuration | | +| `resolution` | [Optional[components.VideoGenerationRequestResolution]](../components/videogenerationrequestresolution.mdx) | ➖ | Resolution of the generated video | 720p | +| `seed` | *Optional[int]* | ➖ | 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. | | +| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | +| `trace` | [Optional[components.TraceConfig]](../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"
} | +| `upscale_factor` | *Optional[float]* | ➖ | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | +| `user` | *Optional[str]* | ➖ | 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/components/videogenerationrequestoptions.mdx b/docs/components/videogenerationrequestoptions.mdx index 669232418..62b937bfc 100644 --- a/docs/components/videogenerationrequestoptions.mdx +++ b/docs/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` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ai21` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `aion_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `akashml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `alibaba` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `amazon_bedrock` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `amazon_nova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ambient` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `anthropic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `anthropic_2` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `anyscale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `arcee_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `assemblyai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `atlas_cloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `atoma` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `avian` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `azure` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `baidu` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `baseten` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `black_forest_labs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `byteplus` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `centml` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cerebras` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `chutes` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cirrascale` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `clarifai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `claude_on_aws` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cloudflare` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cohere` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `coreweave` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `cosine` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `crofai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `crucible` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `crusoe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `darkbloom` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `databricks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `decart` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deepgram` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deepinfra` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deepseek` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `dekallm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `digitalocean` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `elevenlabs` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `enfer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `fake_provider` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `featherless` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `fireworks` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `fish_audio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `friendli` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `gmicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `google_ai_studio` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `google_vertex` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `gopomelo` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `groq` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `heygen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `huggingface` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `hyperbolic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `hyperbolic_quantized` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inception` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inferact_vllm` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inference_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `infermatic` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `inocloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `io_net` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ionstream` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `klusterai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `krea` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lambda_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lepton` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `liquid` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lynn` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `lynn_private` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `makora` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mancer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mancer_old` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mara` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `meta` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `minimax` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mistral` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `modal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `modelrun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `modular` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `moonshotai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `morph` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ncompass` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `near_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nebius` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nex_agi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nextbit` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nineteen` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `novita` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `nvidia` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `octoai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ollama` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `open_inference` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `openai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `parasail` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `perceptron` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `perplexity` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `phala` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `poolside` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `primeintellect` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `quiver` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `recraft` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `recursal` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `reflection` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `reka` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `relace` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `replicate` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `respan` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `runway` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sail_research` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sakana` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sakana_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sambanova` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sambanova_cloaked` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `scaledown` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `seed` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sf_compute` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `siliconflow` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `sourceful` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `stealth` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `stepfun` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `streamlake` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `switchpoint` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `targon` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `tencent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `tenstorrent` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `thinkingmachines` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `together` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `together_lite` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `typesafe` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `ubicloud` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `unbiased` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `upstage` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `venice` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `voyageai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `wafer` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `wandb` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `wandb_legacy` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `xai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `xiaomi` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `z_ai` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `oneai` | Dict[str, *Any*] | ➖ | N/A | +| `ai21` | Dict[str, *Any*] | ➖ | N/A | +| `aion_labs` | Dict[str, *Any*] | ➖ | N/A | +| `akashml` | Dict[str, *Any*] | ➖ | N/A | +| `alibaba` | Dict[str, *Any*] | ➖ | N/A | +| `amazon_bedrock` | Dict[str, *Any*] | ➖ | N/A | +| `amazon_bedrock_claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | +| `amazon_nova` | Dict[str, *Any*] | ➖ | N/A | +| `ambient` | Dict[str, *Any*] | ➖ | N/A | +| `anthropic` | Dict[str, *Any*] | ➖ | N/A | +| `anthropic_2` | Dict[str, *Any*] | ➖ | N/A | +| `anyscale` | Dict[str, *Any*] | ➖ | N/A | +| `arcee_ai` | Dict[str, *Any*] | ➖ | N/A | +| `assemblyai` | Dict[str, *Any*] | ➖ | N/A | +| `atlas_cloud` | Dict[str, *Any*] | ➖ | N/A | +| `atoma` | Dict[str, *Any*] | ➖ | N/A | +| `avian` | Dict[str, *Any*] | ➖ | N/A | +| `azure` | Dict[str, *Any*] | ➖ | N/A | +| `baidu` | Dict[str, *Any*] | ➖ | N/A | +| `baseten` | Dict[str, *Any*] | ➖ | N/A | +| `black_forest_labs` | Dict[str, *Any*] | ➖ | N/A | +| `byteplus` | Dict[str, *Any*] | ➖ | N/A | +| `centml` | Dict[str, *Any*] | ➖ | N/A | +| `cerebras` | Dict[str, *Any*] | ➖ | N/A | +| `chutes` | Dict[str, *Any*] | ➖ | N/A | +| `cirrascale` | Dict[str, *Any*] | ➖ | N/A | +| `clarifai` | Dict[str, *Any*] | ➖ | N/A | +| `claude_on_aws` | Dict[str, *Any*] | ➖ | N/A | +| `cloudflare` | Dict[str, *Any*] | ➖ | N/A | +| `cohere` | Dict[str, *Any*] | ➖ | N/A | +| `coreweave` | Dict[str, *Any*] | ➖ | N/A | +| `cosine` | Dict[str, *Any*] | ➖ | N/A | +| `crofai` | Dict[str, *Any*] | ➖ | N/A | +| `crucible` | Dict[str, *Any*] | ➖ | N/A | +| `crusoe` | Dict[str, *Any*] | ➖ | N/A | +| `darkbloom` | Dict[str, *Any*] | ➖ | N/A | +| `databricks` | Dict[str, *Any*] | ➖ | N/A | +| `decart` | Dict[str, *Any*] | ➖ | N/A | +| `deepgram` | Dict[str, *Any*] | ➖ | N/A | +| `deepinfra` | Dict[str, *Any*] | ➖ | N/A | +| `deepseek` | Dict[str, *Any*] | ➖ | N/A | +| `dekallm` | Dict[str, *Any*] | ➖ | N/A | +| `digitalocean` | Dict[str, *Any*] | ➖ | N/A | +| `elevenlabs` | Dict[str, *Any*] | ➖ | N/A | +| `enfer` | Dict[str, *Any*] | ➖ | N/A | +| `fake_provider` | Dict[str, *Any*] | ➖ | N/A | +| `featherless` | Dict[str, *Any*] | ➖ | N/A | +| `fireworks` | Dict[str, *Any*] | ➖ | N/A | +| `fish_audio` | Dict[str, *Any*] | ➖ | N/A | +| `friendli` | Dict[str, *Any*] | ➖ | N/A | +| `gmicloud` | Dict[str, *Any*] | ➖ | N/A | +| `google_ai_studio` | Dict[str, *Any*] | ➖ | N/A | +| `google_vertex` | Dict[str, *Any*] | ➖ | N/A | +| `gopomelo` | Dict[str, *Any*] | ➖ | N/A | +| `groq` | Dict[str, *Any*] | ➖ | N/A | +| `heygen` | Dict[str, *Any*] | ➖ | N/A | +| `huggingface` | Dict[str, *Any*] | ➖ | N/A | +| `hyperbolic` | Dict[str, *Any*] | ➖ | N/A | +| `hyperbolic_quantized` | Dict[str, *Any*] | ➖ | N/A | +| `inception` | Dict[str, *Any*] | ➖ | N/A | +| `inceptron` | Dict[str, *Any*] | ➖ | N/A | +| `inferact_vllm` | Dict[str, *Any*] | ➖ | N/A | +| `inference_net` | Dict[str, *Any*] | ➖ | N/A | +| `infermatic` | Dict[str, *Any*] | ➖ | N/A | +| `inflection` | Dict[str, *Any*] | ➖ | N/A | +| `inocloud` | Dict[str, *Any*] | ➖ | N/A | +| `io_net` | Dict[str, *Any*] | ➖ | N/A | +| `ionstream` | Dict[str, *Any*] | ➖ | N/A | +| `klusterai` | Dict[str, *Any*] | ➖ | N/A | +| `krea` | Dict[str, *Any*] | ➖ | N/A | +| `lambda_` | Dict[str, *Any*] | ➖ | N/A | +| `lepton` | Dict[str, *Any*] | ➖ | N/A | +| `liquid` | Dict[str, *Any*] | ➖ | N/A | +| `lynn` | Dict[str, *Any*] | ➖ | N/A | +| `lynn_private` | Dict[str, *Any*] | ➖ | N/A | +| `makora` | Dict[str, *Any*] | ➖ | N/A | +| `mancer` | Dict[str, *Any*] | ➖ | N/A | +| `mancer_old` | Dict[str, *Any*] | ➖ | N/A | +| `mara` | Dict[str, *Any*] | ➖ | N/A | +| `meta` | Dict[str, *Any*] | ➖ | N/A | +| `minimax` | Dict[str, *Any*] | ➖ | N/A | +| `mistral` | Dict[str, *Any*] | ➖ | N/A | +| `modal` | Dict[str, *Any*] | ➖ | N/A | +| `modelrun` | Dict[str, *Any*] | ➖ | N/A | +| `modular` | Dict[str, *Any*] | ➖ | N/A | +| `moonshotai` | Dict[str, *Any*] | ➖ | N/A | +| `morph` | Dict[str, *Any*] | ➖ | N/A | +| `ncompass` | Dict[str, *Any*] | ➖ | N/A | +| `near_ai` | Dict[str, *Any*] | ➖ | N/A | +| `nebius` | Dict[str, *Any*] | ➖ | N/A | +| `nex_agi` | Dict[str, *Any*] | ➖ | N/A | +| `nextbit` | Dict[str, *Any*] | ➖ | N/A | +| `nineteen` | Dict[str, *Any*] | ➖ | N/A | +| `novita` | Dict[str, *Any*] | ➖ | N/A | +| `nvidia` | Dict[str, *Any*] | ➖ | N/A | +| `octoai` | Dict[str, *Any*] | ➖ | N/A | +| `ollama` | Dict[str, *Any*] | ➖ | N/A | +| `open_inference` | Dict[str, *Any*] | ➖ | N/A | +| `openai` | Dict[str, *Any*] | ➖ | N/A | +| `parasail` | Dict[str, *Any*] | ➖ | N/A | +| `perceptron` | Dict[str, *Any*] | ➖ | N/A | +| `perplexity` | Dict[str, *Any*] | ➖ | N/A | +| `phala` | Dict[str, *Any*] | ➖ | N/A | +| `poolside` | Dict[str, *Any*] | ➖ | N/A | +| `primeintellect` | Dict[str, *Any*] | ➖ | N/A | +| `quiver` | Dict[str, *Any*] | ➖ | N/A | +| `recraft` | Dict[str, *Any*] | ➖ | N/A | +| `recursal` | Dict[str, *Any*] | ➖ | N/A | +| `reflection` | Dict[str, *Any*] | ➖ | N/A | +| `reka` | Dict[str, *Any*] | ➖ | N/A | +| `relace` | Dict[str, *Any*] | ➖ | N/A | +| `replicate` | Dict[str, *Any*] | ➖ | N/A | +| `respan` | Dict[str, *Any*] | ➖ | N/A | +| `runway` | Dict[str, *Any*] | ➖ | N/A | +| `sail_research` | Dict[str, *Any*] | ➖ | N/A | +| `sakana` | Dict[str, *Any*] | ➖ | N/A | +| `sakana_ai` | Dict[str, *Any*] | ➖ | N/A | +| `sambanova` | Dict[str, *Any*] | ➖ | N/A | +| `sambanova_cloaked` | Dict[str, *Any*] | ➖ | N/A | +| `scaledown` | Dict[str, *Any*] | ➖ | N/A | +| `seed` | Dict[str, *Any*] | ➖ | N/A | +| `sf_compute` | Dict[str, *Any*] | ➖ | N/A | +| `siliconflow` | Dict[str, *Any*] | ➖ | N/A | +| `sourceful` | Dict[str, *Any*] | ➖ | N/A | +| `stealth` | Dict[str, *Any*] | ➖ | N/A | +| `stepfun` | Dict[str, *Any*] | ➖ | N/A | +| `streamlake` | Dict[str, *Any*] | ➖ | N/A | +| `switchpoint` | Dict[str, *Any*] | ➖ | N/A | +| `targon` | Dict[str, *Any*] | ➖ | N/A | +| `tencent` | Dict[str, *Any*] | ➖ | N/A | +| `tenstorrent` | Dict[str, *Any*] | ➖ | N/A | +| `thinkingmachines` | Dict[str, *Any*] | ➖ | N/A | +| `together` | Dict[str, *Any*] | ➖ | N/A | +| `together_lite` | Dict[str, *Any*] | ➖ | N/A | +| `typesafe` | Dict[str, *Any*] | ➖ | N/A | +| `ubicloud` | Dict[str, *Any*] | ➖ | N/A | +| `unbiased` | Dict[str, *Any*] | ➖ | N/A | +| `upstage` | Dict[str, *Any*] | ➖ | N/A | +| `venice` | Dict[str, *Any*] | ➖ | N/A | +| `voyageai` | Dict[str, *Any*] | ➖ | N/A | +| `wafer` | Dict[str, *Any*] | ➖ | N/A | +| `wandb` | Dict[str, *Any*] | ➖ | N/A | +| `wandb_legacy` | Dict[str, *Any*] | ➖ | N/A | +| `xai` | Dict[str, *Any*] | ➖ | N/A | +| `xiaomi` | Dict[str, *Any*] | ➖ | N/A | +| `z_ai` | Dict[str, *Any*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/videogenerationrequestprovider.mdx b/docs/components/videogenerationrequestprovider.mdx index 63d009579..7fc69a9d5 100644 --- a/docs/components/videogenerationrequestprovider.mdx +++ b/docs/components/videogenerationrequestprovider.mdx @@ -9,4 +9,4 @@ Provider-specific passthrough configuration | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `options` | [Optional[components.VideoGenerationRequestOptions]](../components/videogenerationrequestoptions.mdx) | :heavy_minus_sign: | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file +| `options` | [Optional[components.VideoGenerationRequestOptions]](../components/videogenerationrequestoptions.mdx) | ➖ | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file diff --git a/docs/components/videogenerationresponse.mdx b/docs/components/videogenerationresponse.mdx index ac588d7de..c73f8bd2d 100644 --- a/docs/components/videogenerationresponse.mdx +++ b/docs/components/videogenerationresponse.mdx @@ -6,11 +6,11 @@ title: "VideoGenerationResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `error` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `expires_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp in seconds when OpenRouter's stored copy of the outputs stops being available. Present only when that copy exists. | | -| `generation_id` | *Optional[str]* | :heavy_minus_sign: | The generation ID associated with this video generation job. Available once the job has been processed. | | -| `id` | *str* | :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. | | -| `polling_url` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.VideoGenerationResponseStatus](../components/videogenerationresponsestatus.mdx) | :heavy_check_mark: | N/A | | -| `unsigned_urls` | List[*str*] | :heavy_minus_sign: | N/A | | -| `usage` | [Optional[components.VideoGenerationUsage]](../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` | *Optional[str]* | ➖ | N/A | | +| `expires_at` | *Optional[int]* | ➖ | Unix timestamp in seconds when OpenRouter's stored copy of the outputs stops being available. Present only when that copy exists. | | +| `generation_id` | *Optional[str]* | ➖ | The generation ID associated with this video generation job. Available once the job has been processed. | | +| `id` | *str* | ✅ | The video job ID, in the `gen-vid--<20 alphanumerics>` generation ID format. Pass it as `previous_job_id` to continue the generation. | | +| `polling_url` | *str* | ✅ | N/A | | +| `status` | [components.VideoGenerationResponseStatus](../components/videogenerationresponsestatus.mdx) | ✅ | N/A | | +| `unsigned_urls` | List[*str*] | ➖ | N/A | | +| `usage` | [Optional[components.VideoGenerationUsage]](../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/components/videogenerationusage.mdx b/docs/components/videogenerationusage.mdx index 191665906..cc366e2b1 100644 --- a/docs/components/videogenerationusage.mdx +++ b/docs/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[float]* | :heavy_minus_sign: | The cost of the video generation in USD. | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file +| `cost` | *OptionalNullable[float]* | ➖ | The cost of the video generation in USD. | +| `is_byok` | *Optional[bool]* | ➖ | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file diff --git a/docs/components/videomodel.mdx b/docs/components/videomodel.mdx index ebe922ee8..37ead2bb7 100644 --- a/docs/components/videomodel.mdx +++ b/docs/components/videomodel.mdx @@ -6,20 +6,20 @@ title: "VideoModel" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `allowed_passthrough_parameters` | List[*str*] | :heavy_check_mark: | List of parameters that are allowed to be passed through to the provider | | -| `canonical_slug` | *str* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `creativity` | List[*int*] | :heavy_check_mark: | Supported creativity levels for video upscaling models | | -| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `generate_audio` | *Nullable[bool]* | :heavy_check_mark: | Whether the model supports generating audio alongside video | | -| `hugging_face_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `pricing_skus` | Dict[str, *str*] | :heavy_minus_sign: | Pricing SKUs with provider prefix stripped, values as strings | | -| `seed` | *Nullable[bool]* | :heavy_check_mark: | Whether the model supports deterministic generation via seed parameter | | -| `supported_aspect_ratios` | List[[components.SupportedAspectRatio](../components/supportedaspectratio.mdx)] | :heavy_check_mark: | Supported output aspect ratios | | -| `supported_durations` | List[*int*] | :heavy_check_mark: | Supported video durations in seconds | | -| `supported_frame_images` | List[[components.SupportedFrameImage](../components/supportedframeimage.mdx)] | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | -| `supported_resolutions` | List[[components.SupportedResolution](../components/supportedresolution.mdx)] | :heavy_check_mark: | Supported output resolutions | | -| `supported_sizes` | List[[components.SupportedSize](../components/supportedsize.mdx)] | :heavy_check_mark: | Supported output sizes (width x height) | | -| `upscale_factor` | [Nullable[components.UpscaleFactor]](../components/upscalefactor.mdx) | :heavy_check_mark: | Supported upscale factor range for video upscaling models | | \ No newline at end of file +| `allowed_passthrough_parameters` | List[*str*] | ✅ | List of parameters that are allowed to be passed through to the provider | | +| `canonical_slug` | *str* | ✅ | Canonical slug for the model | openai/gpt-4 | +| `created` | *int* | ✅ | Unix timestamp of when the model was created | 1692901234 | +| `creativity` | List[*int*] | ✅ | Supported creativity levels for video upscaling models | | +| `description` | *Optional[str]* | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `generate_audio` | *Nullable[bool]* | ✅ | Whether the model supports generating audio alongside video | | +| `hugging_face_id` | *OptionalNullable[str]* | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `id` | *str* | ✅ | Unique identifier for the model | openai/gpt-4 | +| `name` | *str* | ✅ | Display name of the model | GPT-4 | +| `pricing_skus` | Dict[str, *str*] | ➖ | Pricing SKUs with provider prefix stripped, values as strings | | +| `seed` | *Nullable[bool]* | ✅ | Whether the model supports deterministic generation via seed parameter | | +| `supported_aspect_ratios` | List[[components.SupportedAspectRatio](../components/supportedaspectratio.mdx)] | ✅ | Supported output aspect ratios | | +| `supported_durations` | List[*int*] | ✅ | Supported video durations in seconds | | +| `supported_frame_images` | List[[components.SupportedFrameImage](../components/supportedframeimage.mdx)] | ✅ | Supported frame image types (e.g. first_frame, last_frame) | | +| `supported_resolutions` | List[[components.SupportedResolution](../components/supportedresolution.mdx)] | ✅ | Supported output resolutions | | +| `supported_sizes` | List[[components.SupportedSize](../components/supportedsize.mdx)] | ✅ | Supported output sizes (width x height) | | +| `upscale_factor` | [Nullable[components.UpscaleFactor]](../components/upscalefactor.mdx) | ✅ | Supported upscale factor range for video upscaling models | | \ No newline at end of file diff --git a/docs/components/videomodelslistresponse.mdx b/docs/components/videomodelslistresponse.mdx index 9199c3b3d..5e4643eec 100644 --- a/docs/components/videomodelslistresponse.mdx +++ b/docs/components/videomodelslistresponse.mdx @@ -6,4 +6,4 @@ title: "VideoModelsListResponse" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data` | List[[components.VideoModel](../components/videomodel.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.VideoModel](../components/videomodel.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/videourl.mdx b/docs/components/videourl.mdx index 7cbbaeaa0..334e57e27 100644 --- a/docs/components/videourl.mdx +++ b/docs/components/videourl.mdx @@ -6,4 +6,4 @@ title: "VideoURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/webfetchplugin.mdx b/docs/components/webfetchplugin.mdx index f46512871..d4d69a4e7 100644 --- a/docs/components/webfetchplugin.mdx +++ b/docs/components/webfetchplugin.mdx @@ -6,8 +6,8 @@ title: "WebFetchPlugin" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | Only fetch from these domains. | -| `blocked_domains` | List[*str*] | :heavy_minus_sign: | Never fetch from these domains. | -| `id` | [components.WebFetchPluginID](../components/webfetchpluginid.mdx) | :heavy_check_mark: | N/A | -| `max_content_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | -| `max_uses` | *Optional[int]* | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file +| `allowed_domains` | List[*str*] | ➖ | Only fetch from these domains. | +| `blocked_domains` | List[*str*] | ➖ | Never fetch from these domains. | +| `id` | [components.WebFetchPluginID](../components/webfetchpluginid.mdx) | ✅ | N/A | +| `max_content_tokens` | *Optional[int]* | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | +| `max_uses` | *Optional[int]* | ➖ | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file diff --git a/docs/components/webfetchservertool.mdx b/docs/components/webfetchservertool.mdx index fe93938c6..7e817ae82 100644 --- a/docs/components/webfetchservertool.mdx +++ b/docs/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` | [Optional[components.WebFetchServerToolConfig]](../components/webfetchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | -| `type` | [components.WebFetchServerToolType](../components/webfetchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.WebFetchServerToolConfig]](../components/webfetchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | +| `type` | [components.WebFetchServerToolType](../components/webfetchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/webfetchservertoolconfig.mdx b/docs/components/webfetchservertoolconfig.mdx index 1d52d81ac..368d24755 100644 --- a/docs/components/webfetchservertoolconfig.mdx +++ b/docs/components/webfetchservertoolconfig.mdx @@ -9,8 +9,8 @@ Configuration for the openrouter:web_fetch server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | Only fetch from these domains. | | -| `blocked_domains` | List[*str*] | :heavy_minus_sign: | Never fetch from these domains. | | -| `engine` | [Optional[components.WebFetchEngineEnum]](../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 | -| `max_content_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | -| `max_uses` | *Optional[int]* | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file +| `allowed_domains` | List[*str*] | ➖ | Only fetch from these domains. | | +| `blocked_domains` | List[*str*] | ➖ | Never fetch from these domains. | | +| `engine` | [Optional[components.WebFetchEngineEnum]](../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 | +| `max_content_tokens` | *Optional[int]* | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | +| `max_uses` | *Optional[int]* | ➖ | 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/components/websearchcallcompletedevent.mdx b/docs/components/websearchcallcompletedevent.mdx index 34bcc1fe4..61fa977f3 100644 --- a/docs/components/websearchcallcompletedevent.mdx +++ b/docs/components/websearchcallcompletedevent.mdx @@ -9,7 +9,7 @@ Web search call completed | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.WebSearchCallCompletedEventType](../components/websearchcallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.WebSearchCallCompletedEventType](../components/websearchcallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/websearchcallinprogressevent.mdx b/docs/components/websearchcallinprogressevent.mdx index eaf3e6060..f0d552ca8 100644 --- a/docs/components/websearchcallinprogressevent.mdx +++ b/docs/components/websearchcallinprogressevent.mdx @@ -9,7 +9,7 @@ Web search call in progress | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.WebSearchCallInProgressEventType](../components/websearchcallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.WebSearchCallInProgressEventType](../components/websearchcallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/websearchcallsearchingevent.mdx b/docs/components/websearchcallsearchingevent.mdx index 5cd281053..2a4da1904 100644 --- a/docs/components/websearchcallsearchingevent.mdx +++ b/docs/components/websearchcallsearchingevent.mdx @@ -9,7 +9,7 @@ Web search call is searching | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.WebSearchCallSearchingEventType](../components/websearchcallsearchingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `item_id` | *str* | ✅ | N/A | +| `output_index` | *int* | ✅ | N/A | +| `sequence_number` | *int* | ✅ | N/A | +| `type` | [components.WebSearchCallSearchingEventType](../components/websearchcallsearchingeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/websearchcitation.mdx b/docs/components/websearchcitation.mdx index c95316353..a0faca26c 100644 --- a/docs/components/websearchcitation.mdx +++ b/docs/components/websearchcitation.mdx @@ -6,7 +6,7 @@ title: "WebSearchCitation" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `cited_text` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `encrypted_index` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `cited_text` | *Optional[str]* | ➖ | N/A | +| `encrypted_index` | *Optional[str]* | ➖ | N/A | +| `title` | *Nullable[str]* | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/websearchconfig.mdx b/docs/components/websearchconfig.mdx index b7671cf8a..cdfd73106 100644 --- a/docs/components/websearchconfig.mdx +++ b/docs/components/websearchconfig.mdx @@ -6,14 +6,14 @@ title: "WebSearchConfig" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :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` | [Optional[components.WebSearchEngineEnum]](../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 | -| `excluded_domains` | List[*str*] | :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. | | -| `max_characters` | *Optional[int]* | :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 | -| `max_results` | *Optional[int]* | :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 | -| `max_total_results` | *Optional[int]* | :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 | -| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchQualityLevel]](../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 | -| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../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"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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 +| `allowed_domains` | List[*str*] | ➖ | 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` | [Optional[components.WebSearchEngineEnum]](../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 | +| `excluded_domains` | List[*str*] | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `max_characters` | *Optional[int]* | ➖ | 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 | +| `max_results` | *Optional[int]* | ➖ | 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 | +| `max_total_results` | *Optional[int]* | ➖ | 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 | +| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchQualityLevel]](../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 | +| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/websearchdomainfilter.mdx b/docs/components/websearchdomainfilter.mdx index de20da275..75b7b15dd 100644 --- a/docs/components/websearchdomainfilter.mdx +++ b/docs/components/websearchdomainfilter.mdx @@ -6,6 +6,6 @@ title: "WebSearchDomainFilter" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | -| `blocked_domains` | List[*str*] | :heavy_minus_sign: | N/A | -| `excluded_domains` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `allowed_domains` | List[*str*] | ➖ | N/A | +| `blocked_domains` | List[*str*] | ➖ | N/A | +| `excluded_domains` | List[*str*] | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/websearchplugin.mdx b/docs/components/websearchplugin.mdx index 6cd0c9a77..8ef5667f5 100644 --- a/docs/components/websearchplugin.mdx +++ b/docs/components/websearchplugin.mdx @@ -6,14 +6,14 @@ title: "WebSearchPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | -| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.mdx) | :heavy_minus_sign: | The search engine to use for web search. | exa | -| `exclude_domains` | List[*str*] | :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](../components/websearchpluginid.mdx) | :heavy_check_mark: | N/A | | -| `include_domains` | List[*str*] | :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"
] | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | -| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `user_location` | [OptionalNullable[components.UserLocation]](../components/userlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | *Optional[bool]* | ➖ | Set to false to disable the web-search plugin for this request. Defaults to true. | | +| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.mdx) | ➖ | The search engine to use for web search. | exa | +| `exclude_domains` | List[*str*] | ➖ | 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](../components/websearchpluginid.mdx) | ✅ | N/A | | +| `include_domains` | List[*str*] | ➖ | 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"
] | +| `max_results` | *Optional[int]* | ➖ | N/A | | +| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | +| `search_prompt` | *Optional[str]* | ➖ | N/A | | +| `user_location` | [OptionalNullable[components.UserLocation]](../components/userlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/websearchservertool.mdx b/docs/components/websearchservertool.mdx index 4a66fcbb5..6b93c896c 100644 --- a/docs/components/websearchservertool.mdx +++ b/docs/components/websearchservertool.mdx @@ -9,12 +9,12 @@ Web search tool configuration (2025-08-26 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `max_results` | *Optional[int]* | :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 | -| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [components.WebSearchServerToolType](../components/websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../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"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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` | [Optional[components.WebSearchEngineEnum]](../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[components.WebSearchDomainFilter]](../components/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `max_results` | *Optional[int]* | ➖ | 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 | +| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `type` | [components.WebSearchServerToolType](../components/websearchservertooltype.mdx) | ✅ | N/A | | +| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../components/websearchuserlocation.mdx) | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/websearchservertoolconfig.mdx b/docs/components/websearchservertoolconfig.mdx index 206799c77..832dce858 100644 --- a/docs/components/websearchservertoolconfig.mdx +++ b/docs/components/websearchservertoolconfig.mdx @@ -9,14 +9,14 @@ Configuration for the openrouter:web_search server tool | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :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` | [Optional[components.WebSearchEngineEnum]](../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 | -| `excluded_domains` | List[*str*] | :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. | | -| `max_characters` | *Optional[int]* | :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 | -| `max_results` | *Optional[int]* | :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 | -| `max_total_results` | *Optional[int]* | :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 | -| `max_uses` | *Optional[int]* | :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` | [Optional[components.WebSearchMode]](../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 | -| `search_context_size` | [Optional[components.SearchQualityLevel]](../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 | -| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../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"
} | -| `x_search` | [Optional[components.XSearchOptions]](../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 +| `allowed_domains` | List[*str*] | ➖ | 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` | [Optional[components.WebSearchEngineEnum]](../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 | +| `excluded_domains` | List[*str*] | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `max_characters` | *Optional[int]* | ➖ | 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 | +| `max_results` | *Optional[int]* | ➖ | 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 | +| `max_total_results` | *Optional[int]* | ➖ | 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 | +| `max_uses` | *Optional[int]* | ➖ | 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` | [Optional[components.WebSearchMode]](../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 | +| `search_context_size` | [Optional[components.SearchQualityLevel]](../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 | +| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `x_search` | [Optional[components.XSearchOptions]](../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/components/websearchservertoolopenrouter.mdx b/docs/components/websearchservertoolopenrouter.mdx index 1e3301d31..5c7db3ebf 100644 --- a/docs/components/websearchservertoolopenrouter.mdx +++ b/docs/components/websearchservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.WebSearchServerToolConfig]](../components/websearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `type` | [components.WebSearchServerToolOpenRouterType](../components/websearchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [Optional[components.WebSearchServerToolConfig]](../components/websearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `type` | [components.WebSearchServerToolOpenRouterType](../components/websearchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/components/websearchsource.mdx b/docs/components/websearchsource.mdx index 870075f95..35bdea156 100644 --- a/docs/components/websearchsource.mdx +++ b/docs/components/websearchsource.mdx @@ -6,5 +6,5 @@ title: "WebSearchSource" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.WebSearchSourceType](../components/websearchsourcetype.mdx) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [components.WebSearchSourceType](../components/websearchsourcetype.mdx) | ✅ | N/A | +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/components/websearchuserlocation.mdx b/docs/components/websearchuserlocation.mdx index dccb9d9a1..1c3895f5e 100644 --- a/docs/components/websearchuserlocation.mdx +++ b/docs/components/websearchuserlocation.mdx @@ -9,8 +9,8 @@ User location information for web search | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [Optional[components.WebSearchUserLocationType]](../components/websearchuserlocationtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | ➖ | N/A | +| `country` | *OptionalNullable[str]* | ➖ | N/A | +| `region` | *OptionalNullable[str]* | ➖ | N/A | +| `timezone` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [Optional[components.WebSearchUserLocationType]](../components/websearchuserlocationtype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/websearchuserlocationservertool.mdx b/docs/components/websearchuserlocationservertool.mdx index 98a2e0b60..1bd2f8c6e 100644 --- a/docs/components/websearchuserlocationservertool.mdx +++ b/docs/components/websearchuserlocationservertool.mdx @@ -9,8 +9,8 @@ Approximate user location for location-biased results. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [Optional[components.WebSearchUserLocationServerToolType]](../components/websearchuserlocationservertooltype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `city` | *OptionalNullable[str]* | ➖ | N/A | +| `country` | *OptionalNullable[str]* | ➖ | N/A | +| `region` | *OptionalNullable[str]* | ➖ | N/A | +| `timezone` | *OptionalNullable[str]* | ➖ | N/A | +| `type` | [Optional[components.WebSearchUserLocationServerToolType]](../components/websearchuserlocationservertooltype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/components/workspace.mdx b/docs/components/workspace.mdx index e3866ea05..fff268dd0 100644 --- a/docs/components/workspace.mdx +++ b/docs/components/workspace.mdx @@ -6,21 +6,21 @@ title: "Workspace" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | -| `created_by` | *Nullable[str]* | :heavy_check_mark: | User ID of the workspace creator | user_abc123 | -| `default_guardrail_id` | *str* | :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 | -| `default_image_model` | *Nullable[str]* | :heavy_check_mark: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *Nullable[str]* | :heavy_check_mark: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *Nullable[str]* | :heavy_check_mark: | Default text model for this workspace | openai/gpt-4o | -| `description` | *Nullable[str]* | :heavy_check_mark: | Description of the workspace | Production environment workspace | -| `disabled_server_tools` | List[*str*] | :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` | *str* | :heavy_check_mark: | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | -| `include_byok_in_budgets` | *Optional[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 | -| `io_logging_api_key_ids` | List[*int*] | :heavy_check_mark: | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | -| `io_logging_sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | -| `is_data_discount_logging_enabled` | *bool* | :heavy_check_mark: | Whether data discount logging is enabled for this workspace | true | -| `is_observability_broadcast_enabled` | *bool* | :heavy_check_mark: | Whether broadcast is enabled for this workspace | false | -| `is_observability_io_logging_enabled` | *bool* | :heavy_check_mark: | Whether private logging is enabled for this workspace | false | -| `name` | *str* | :heavy_check_mark: | Name of the workspace | Production | -| `slug` | *str* | :heavy_check_mark: | URL-friendly slug for the workspace | production | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | +| `created_by` | *Nullable[str]* | ✅ | User ID of the workspace creator | user_abc123 | +| `default_guardrail_id` | *str* | ✅ | Deterministic ID derived from the workspace ID. The default guardrail is materialized when its configuration is first written. | 595d5849-7e86-51fd-a7c0-705c34e4afff | +| `default_image_model` | *Nullable[str]* | ✅ | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *Nullable[str]* | ✅ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *Nullable[str]* | ✅ | Default text model for this workspace | openai/gpt-4o | +| `description` | *Nullable[str]* | ✅ | Description of the workspace | Production environment workspace | +| `disabled_server_tools` | List[*str*] | ➖ | OpenRouter server tools (e.g. openrouter:web_search) that requests in this workspace may not invoke. Null means no tools are disabled. | null | +| `id` | *str* | ✅ | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | +| `include_byok_in_budgets` | *Optional[bool]* | ➖ | Whether BYOK (bring-your-own-key) spend counts toward this workspace's budgets. Set it via the workspace budget endpoints. | false | +| `io_logging_api_key_ids` | List[*int*] | ✅ | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | +| `io_logging_sampling_rate` | *float* | ✅ | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | +| `is_data_discount_logging_enabled` | *bool* | ✅ | Whether data discount logging is enabled for this workspace | true | +| `is_observability_broadcast_enabled` | *bool* | ✅ | Whether broadcast is enabled for this workspace | false | +| `is_observability_io_logging_enabled` | *bool* | ✅ | Whether private logging is enabled for this workspace | false | +| `name` | *str* | ✅ | Name of the workspace | Production | +| `slug` | *str* | ✅ | URL-friendly slug for the workspace | production | +| `updated_at` | *Nullable[str]* | ✅ | 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/components/workspacebudget.mdx b/docs/components/workspacebudget.mdx index 90cef4e9c..4dfb369b9 100644 --- a/docs/components/workspacebudget.mdx +++ b/docs/components/workspacebudget.mdx @@ -6,9 +6,9 @@ title: "WorkspaceBudget" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | -| `limit_usd` | *float* | :heavy_check_mark: | Spending limit in USD for this interval | 100 | -| `reset_interval` | [Nullable[components.WorkspaceBudgetResetInterval]](../components/workspacebudgetresetinterval.mdx) | :heavy_check_mark: | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | -| `updated_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | +| `id` | *str* | ✅ | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | +| `limit_usd` | *float* | ✅ | Spending limit in USD for this interval | 100 | +| `reset_interval` | [Nullable[components.WorkspaceBudgetResetInterval]](../components/workspacebudgetresetinterval.mdx) | ✅ | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | +| `updated_at` | *str* | ✅ | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | +| `workspace_id` | *str* | ✅ | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/workspacemember.mdx b/docs/components/workspacemember.mdx index 3e77b3d51..48ec5c899 100644 --- a/docs/components/workspacemember.mdx +++ b/docs/components/workspacemember.mdx @@ -6,8 +6,8 @@ title: "WorkspaceMember" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | -| `role` | [components.WorkspaceMemberRole](../components/workspacememberrole.mdx) | :heavy_check_mark: | Role of the member in the workspace | member | -| `user_id` | *str* | :heavy_check_mark: | Clerk user ID of the member | user_abc123 | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | +| `id` | *str* | ✅ | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | +| `role` | [components.WorkspaceMemberRole](../components/workspacememberrole.mdx) | ✅ | Role of the member in the workspace | member | +| `user_id` | *str* | ✅ | Clerk user ID of the member | user_abc123 | +| `workspace_id` | *str* | ✅ | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/components/xsearchoptions.mdx b/docs/components/xsearchoptions.mdx index d742b5c2b..07f069752 100644 --- a/docs/components/xsearchoptions.mdx +++ b/docs/components/xsearchoptions.mdx @@ -9,9 +9,9 @@ Enable SpaceXAI X (Twitter) search alongside native web search, with optional fi | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `allowed_x_handles` | List[*str*] | :heavy_minus_sign: | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | -| `enable_image_understanding` | *Optional[bool]* | :heavy_minus_sign: | Analyze images attached to matching posts. | | -| `enable_video_understanding` | *Optional[bool]* | :heavy_minus_sign: | Analyze videos attached to matching posts. | | -| `excluded_x_handles` | List[*str*] | :heavy_minus_sign: | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | -| `from_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | -| `to_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :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 +| `allowed_x_handles` | List[*str*] | ➖ | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | +| `enable_image_understanding` | *Optional[bool]* | ➖ | Analyze images attached to matching posts. | | +| `enable_video_understanding` | *Optional[bool]* | ➖ | Analyze videos attached to matching posts. | | +| `excluded_x_handles` | List[*str*] | ➖ | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | +| `from_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | ➖ | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | +| `to_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | ➖ | 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/errors/badgatewayresponseerror.mdx b/docs/errors/badgatewayresponseerror.mdx index d596a9c0e..0a1a19d0b 100644 --- a/docs/errors/badgatewayresponseerror.mdx +++ b/docs/errors/badgatewayresponseerror.mdx @@ -9,6 +9,6 @@ Bad Gateway - Provider/upstream API failure | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `error` | [components.BadGatewayResponseErrorData](../components/badgatewayresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.BadGatewayResponseErrorData](../components/badgatewayresponseerrordata.mdx) | ✅ | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/badrequestresponseerror.mdx b/docs/errors/badrequestresponseerror.mdx index 68e67bcf8..7d8daf0cd 100644 --- a/docs/errors/badrequestresponseerror.mdx +++ b/docs/errors/badrequestresponseerror.mdx @@ -9,6 +9,6 @@ Bad Request - Invalid request parameters or malformed input | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `error` | [components.BadRequestResponseErrorData](../components/badrequestresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.BadRequestResponseErrorData](../components/badrequestresponseerrordata.mdx) | ✅ | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/batcherrorresponse.mdx b/docs/errors/batcherrorresponse.mdx index 6b8ce49bb..049632f96 100644 --- a/docs/errors/batcherrorresponse.mdx +++ b/docs/errors/batcherrorresponse.mdx @@ -6,4 +6,4 @@ title: "BatchErrorResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `error` | [components.BatchErrorResponseError](../components/batcherrorresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | [components.BatchErrorResponseError](../components/batcherrorresponseerror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/errors/batchpaymentrequiredresponseerror.mdx b/docs/errors/batchpaymentrequiredresponseerror.mdx index 9c093bb2b..ce0175950 100644 --- a/docs/errors/batchpaymentrequiredresponseerror.mdx +++ b/docs/errors/batchpaymentrequiredresponseerror.mdx @@ -9,15 +9,15 @@ Batch metadata with results withheld (results: null) plus the standard error env | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `completion_window` | [components.BatchPaymentRequiredResponseCompletionWindow](../components/batchpaymentrequiredresponsecompletionwindow.mdx) | :heavy_check_mark: | N/A | -| `created_at` | *int* | :heavy_check_mark: | N/A | -| `endpoint` | *str* | :heavy_check_mark: | N/A | -| `error` | [components.BatchPaymentRequiredResponseError](../components/batchpaymentrequiredresponseerror.mdx) | :heavy_check_mark: | N/A | -| `finalized_at` | *Nullable[int]* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `object` | [components.BatchPaymentRequiredResponseObject](../components/batchpaymentrequiredresponseobject.mdx) | :heavy_check_mark: | N/A | -| `request_counts` | [components.BatchPaymentRequiredResponseRequestCounts](../components/batchpaymentrequiredresponserequestcounts.mdx) | :heavy_check_mark: | N/A | -| `results` | *Nullable[Any]* | :heavy_check_mark: | Always null: results are withheld until the batch charge is covered. | -| `status` | [components.BatchPaymentRequiredResponseStatus](../components/batchpaymentrequiredresponsestatus.mdx) | :heavy_check_mark: | N/A | -| `usage` | [Nullable[components.BatchPaymentRequiredResponseUsage]](../components/batchpaymentrequiredresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `completion_window` | [components.BatchPaymentRequiredResponseCompletionWindow](../components/batchpaymentrequiredresponsecompletionwindow.mdx) | ✅ | N/A | +| `created_at` | *int* | ✅ | N/A | +| `endpoint` | *str* | ✅ | N/A | +| `error` | [components.BatchPaymentRequiredResponseError](../components/batchpaymentrequiredresponseerror.mdx) | ✅ | N/A | +| `finalized_at` | *Nullable[int]* | ✅ | N/A | +| `id` | *str* | ✅ | N/A | +| `model` | *str* | ✅ | N/A | +| `object` | [components.BatchPaymentRequiredResponseObject](../components/batchpaymentrequiredresponseobject.mdx) | ✅ | N/A | +| `request_counts` | [components.BatchPaymentRequiredResponseRequestCounts](../components/batchpaymentrequiredresponserequestcounts.mdx) | ✅ | N/A | +| `results` | *Nullable[Any]* | ✅ | Always null: results are withheld until the batch charge is covered. | +| `status` | [components.BatchPaymentRequiredResponseStatus](../components/batchpaymentrequiredresponsestatus.mdx) | ✅ | N/A | +| `usage` | [Nullable[components.BatchPaymentRequiredResponseUsage]](../components/batchpaymentrequiredresponseusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/errors/conflictresponseerror.mdx b/docs/errors/conflictresponseerror.mdx index c6f96de88..f496472b8 100644 --- a/docs/errors/conflictresponseerror.mdx +++ b/docs/errors/conflictresponseerror.mdx @@ -9,6 +9,6 @@ Conflict - Resource conflict or concurrent modification | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [components.ConflictResponseErrorData](../components/conflictresponseerrordata.mdx) | :heavy_check_mark: | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.ConflictResponseErrorData](../components/conflictresponseerrordata.mdx) | ✅ | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/createprivateendpointvalidationfailedresponseerror.mdx b/docs/errors/createprivateendpointvalidationfailedresponseerror.mdx index 4c63b4d5b..432d5a57a 100644 --- a/docs/errors/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/errors/createprivateendpointvalidationfailedresponseerror.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.CreatePrivateEndpointValidationFailedResponseData](../components/createprivateendpointvalidationfailedresponsedata.mdx) | :heavy_check_mark: | N/A | -| `error` | [components.CreatePrivateEndpointValidationFailedResponseError](../components/createprivateendpointvalidationfailedresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.CreatePrivateEndpointValidationFailedResponseData](../components/createprivateendpointvalidationfailedresponsedata.mdx) | ✅ | N/A | +| `error` | [components.CreatePrivateEndpointValidationFailedResponseError](../components/createprivateendpointvalidationfailedresponseerror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/errors/edgenetworktimeoutresponseerror.mdx b/docs/errors/edgenetworktimeoutresponseerror.mdx index 845c9d6c0..6ddc69ad9 100644 --- a/docs/errors/edgenetworktimeoutresponseerror.mdx +++ b/docs/errors/edgenetworktimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Infrastructure Timeout - Provider request timed out at edge network | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.EdgeNetworkTimeoutResponseErrorData](../components/edgenetworktimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.EdgeNetworkTimeoutResponseErrorData](../components/edgenetworktimeoutresponseerrordata.mdx) | ✅ | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/forbiddenresponseerror.mdx b/docs/errors/forbiddenresponseerror.mdx index 657b79d00..468d326ba 100644 --- a/docs/errors/forbiddenresponseerror.mdx +++ b/docs/errors/forbiddenresponseerror.mdx @@ -9,6 +9,6 @@ Forbidden - Authentication successful but insufficient permissions | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `error` | [components.ForbiddenResponseErrorData](../components/forbiddenresponseerrordata.mdx) | :heavy_check_mark: | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.ForbiddenResponseErrorData](../components/forbiddenresponseerrordata.mdx) | ✅ | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/gatewaytimeoutresponseerror.mdx b/docs/errors/gatewaytimeoutresponseerror.mdx index b16b713f2..20530f230 100644 --- a/docs/errors/gatewaytimeoutresponseerror.mdx +++ b/docs/errors/gatewaytimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Gateway Timeout - Provider did not respond before the upstream deadline | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.GatewayTimeoutResponseErrorData](../components/gatewaytimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.GatewayTimeoutResponseErrorData](../components/gatewaytimeoutresponseerrordata.mdx) | ✅ | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/goneresponseerror.mdx b/docs/errors/goneresponseerror.mdx index 3584e71b6..7df81cbac 100644 --- a/docs/errors/goneresponseerror.mdx +++ b/docs/errors/goneresponseerror.mdx @@ -9,6 +9,6 @@ Gone - Endpoint has been permanently removed or deprecated | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | [components.GoneResponseErrorData](../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."
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.GoneResponseErrorData](../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."
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/internalserverresponseerror.mdx b/docs/errors/internalserverresponseerror.mdx index 2a892b08d..239d837f8 100644 --- a/docs/errors/internalserverresponseerror.mdx +++ b/docs/errors/internalserverresponseerror.mdx @@ -9,6 +9,6 @@ Internal Server Error - Unexpected server error | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.InternalServerResponseErrorData](../components/internalserverresponseerrordata.mdx) | :heavy_check_mark: | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.InternalServerResponseErrorData](../components/internalserverresponseerrordata.mdx) | ✅ | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/internchaterrorresponse.mdx b/docs/errors/internchaterrorresponse.mdx index ec1c162ec..876c46af4 100644 --- a/docs/errors/internchaterrorresponse.mdx +++ b/docs/errors/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](../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](../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/errors/internlifecycleerror.mdx b/docs/errors/internlifecycleerror.mdx index 9de3964c0..0cdbfafe1 100644 --- a/docs/errors/internlifecycleerror.mdx +++ b/docs/errors/internlifecycleerror.mdx @@ -9,4 +9,4 @@ Intern lifecycle request failure. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [components.InternLifecycleErrorError](../components/internlifecycleerrorerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | [components.InternLifecycleErrorError](../components/internlifecycleerrorerror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/errors/notfoundresponseerror.mdx b/docs/errors/notfoundresponseerror.mdx index 5ba79a197..c4fedfe4a 100644 --- a/docs/errors/notfoundresponseerror.mdx +++ b/docs/errors/notfoundresponseerror.mdx @@ -9,6 +9,6 @@ Not Found - Resource does not exist | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [components.NotFoundResponseErrorData](../components/notfoundresponseerrordata.mdx) | :heavy_check_mark: | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.NotFoundResponseErrorData](../components/notfoundresponseerrordata.mdx) | ✅ | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/oautherrorresponse.mdx b/docs/errors/oautherrorresponse.mdx index 9d1631687..2190b45c8 100644 --- a/docs/errors/oautherrorresponse.mdx +++ b/docs/errors/oautherrorresponse.mdx @@ -9,5 +9,5 @@ RFC 6749 §5.2 error response. | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `error` | [components.ErrorEnum](../components/errorenum.mdx) | :heavy_check_mark: | N/A | -| `error_description` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | [components.ErrorEnum](../components/errorenum.mdx) | ✅ | N/A | +| `error_description` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/errors/payloadtoolargeresponseerror.mdx b/docs/errors/payloadtoolargeresponseerror.mdx index ba4d28b0d..e232e3a74 100644 --- a/docs/errors/payloadtoolargeresponseerror.mdx +++ b/docs/errors/payloadtoolargeresponseerror.mdx @@ -9,6 +9,6 @@ Payload Too Large - Request payload exceeds size limits | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.PayloadTooLargeResponseErrorData](../components/payloadtoolargeresponseerrordata.mdx) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.PayloadTooLargeResponseErrorData](../components/payloadtoolargeresponseerrordata.mdx) | ✅ | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/paymentrequiredresponseerror.mdx b/docs/errors/paymentrequiredresponseerror.mdx index f632aa144..cde4a1763 100644 --- a/docs/errors/paymentrequiredresponseerror.mdx +++ b/docs/errors/paymentrequiredresponseerror.mdx @@ -9,6 +9,6 @@ Payment Required - Insufficient credits or quota to complete request | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.PaymentRequiredResponseErrorData](../components/paymentrequiredresponseerrordata.mdx) | :heavy_check_mark: | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.PaymentRequiredResponseErrorData](../components/paymentrequiredresponseerrordata.mdx) | ✅ | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/provideroverloadedresponseerror.mdx b/docs/errors/provideroverloadedresponseerror.mdx index c24817c53..3a024c3b8 100644 --- a/docs/errors/provideroverloadedresponseerror.mdx +++ b/docs/errors/provideroverloadedresponseerror.mdx @@ -9,6 +9,6 @@ Provider Overloaded - Provider is temporarily overloaded | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.ProviderOverloadedResponseErrorData](../components/provideroverloadedresponseerrordata.mdx) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.ProviderOverloadedResponseErrorData](../components/provideroverloadedresponseerrordata.mdx) | ✅ | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/requesttimeoutresponseerror.mdx b/docs/errors/requesttimeoutresponseerror.mdx index 81393cc78..5e35d3b74 100644 --- a/docs/errors/requesttimeoutresponseerror.mdx +++ b/docs/errors/requesttimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Request Timeout - Operation exceeded time limit | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.RequestTimeoutResponseErrorData](../components/requesttimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.RequestTimeoutResponseErrorData](../components/requesttimeoutresponseerrordata.mdx) | ✅ | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/serviceunavailableresponseerror.mdx b/docs/errors/serviceunavailableresponseerror.mdx index 102116c63..6c51ff54d 100644 --- a/docs/errors/serviceunavailableresponseerror.mdx +++ b/docs/errors/serviceunavailableresponseerror.mdx @@ -9,6 +9,6 @@ Service Unavailable - Service temporarily unavailable | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.ServiceUnavailableResponseErrorData](../components/serviceunavailableresponseerrordata.mdx) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.ServiceUnavailableResponseErrorData](../components/serviceunavailableresponseerrordata.mdx) | ✅ | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/toomanyrequestsresponseerror.mdx b/docs/errors/toomanyrequestsresponseerror.mdx index 67bd342ca..bd4d9b5df 100644 --- a/docs/errors/toomanyrequestsresponseerror.mdx +++ b/docs/errors/toomanyrequestsresponseerror.mdx @@ -9,6 +9,6 @@ Too Many Requests - Rate limit exceeded | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.TooManyRequestsResponseErrorData](../components/toomanyrequestsresponseerrordata.mdx) | :heavy_check_mark: | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.TooManyRequestsResponseErrorData](../components/toomanyrequestsresponseerrordata.mdx) | ✅ | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/unauthorizedresponseerror.mdx b/docs/errors/unauthorizedresponseerror.mdx index a24d0576d..81fb945c0 100644 --- a/docs/errors/unauthorizedresponseerror.mdx +++ b/docs/errors/unauthorizedresponseerror.mdx @@ -9,6 +9,6 @@ Unauthorized - Authentication required or invalid credentials | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `error` | [components.UnauthorizedResponseErrorData](../components/unauthorizedresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.UnauthorizedResponseErrorData](../components/unauthorizedresponseerrordata.mdx) | ✅ | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/errors/unprocessableentityresponseerror.mdx b/docs/errors/unprocessableentityresponseerror.mdx index 75813e9f2..6e23a4c1d 100644 --- a/docs/errors/unprocessableentityresponseerror.mdx +++ b/docs/errors/unprocessableentityresponseerror.mdx @@ -9,6 +9,6 @@ Unprocessable Entity - Semantic validation failure | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `error` | [components.UnprocessableEntityResponseErrorData](../components/unprocessableentityresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | -| `openrouter_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [components.UnprocessableEntityResponseErrorData](../components/unprocessableentityresponseerrordata.mdx) | ✅ | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | +| `openrouter_metadata` | Dict[str, *Any*] | ➖ | N/A | | +| `user_id` | *OptionalNullable[str]* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/internal/globals.mdx b/docs/models/internal/globals.mdx index 905f480d8..3ad2ee4c6 100644 --- a/docs/models/internal/globals.mdx +++ b/docs/models/internal/globals.mdx @@ -6,6 +6,6 @@ title: "Globals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/activateprivateendpointglobals.mdx b/docs/operations/activateprivateendpointglobals.mdx index 611b1a254..fdc831c37 100644 --- a/docs/operations/activateprivateendpointglobals.mdx +++ b/docs/operations/activateprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "ActivatePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/activateprivateendpointrequest.mdx b/docs/operations/activateprivateendpointrequest.mdx index fce127cf1..1b7560155 100644 --- a/docs/operations/activateprivateendpointrequest.mdx +++ b/docs/operations/activateprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "ActivatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/operations/bulkaddworkspacemembersglobals.mdx b/docs/operations/bulkaddworkspacemembersglobals.mdx index a53ed3696..29c0083fd 100644 --- a/docs/operations/bulkaddworkspacemembersglobals.mdx +++ b/docs/operations/bulkaddworkspacemembersglobals.mdx @@ -6,6 +6,6 @@ title: "BulkAddWorkspaceMembersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkaddworkspacemembersrequest.mdx b/docs/operations/bulkaddworkspacemembersrequest.mdx index 5b61022c5..e0c7348a6 100644 --- a/docs/operations/bulkaddworkspacemembersrequest.mdx +++ b/docs/operations/bulkaddworkspacemembersrequest.mdx @@ -6,8 +6,8 @@ title: "BulkAddWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulk_add_workspace_members_request` | [components.BulkAddWorkspaceMembersRequest](../components/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `bulk_add_workspace_members_request` | [components.BulkAddWorkspaceMembersRequest](../components/bulkaddworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/operations/bulkassignkeystoguardrailglobals.mdx b/docs/operations/bulkassignkeystoguardrailglobals.mdx index c5e78a4b8..ec73b0f4e 100644 --- a/docs/operations/bulkassignkeystoguardrailglobals.mdx +++ b/docs/operations/bulkassignkeystoguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "BulkAssignKeysToGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkassignkeystoguardrailrequest.mdx b/docs/operations/bulkassignkeystoguardrailrequest.mdx index 47d8a382f..d616eb4d6 100644 --- a/docs/operations/bulkassignkeystoguardrailrequest.mdx +++ b/docs/operations/bulkassignkeystoguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "BulkAssignKeysToGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_assign_keys_request` | [components.BulkAssignKeysRequest](../components/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulk_assign_keys_request` | [components.BulkAssignKeysRequest](../components/bulkassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/operations/bulkassignmemberstoguardrailglobals.mdx b/docs/operations/bulkassignmemberstoguardrailglobals.mdx index 4b04ca8a6..ece4dcbc5 100644 --- a/docs/operations/bulkassignmemberstoguardrailglobals.mdx +++ b/docs/operations/bulkassignmemberstoguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "BulkAssignMembersToGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkassignmemberstoguardrailrequest.mdx b/docs/operations/bulkassignmemberstoguardrailrequest.mdx index ede199d37..e51686259 100644 --- a/docs/operations/bulkassignmemberstoguardrailrequest.mdx +++ b/docs/operations/bulkassignmemberstoguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "BulkAssignMembersToGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_assign_members_request` | [components.BulkAssignMembersRequest](../components/bulkassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulk_assign_members_request` | [components.BulkAssignMembersRequest](../components/bulkassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/operations/bulkremoveworkspacemembersglobals.mdx b/docs/operations/bulkremoveworkspacemembersglobals.mdx index 9b483f8f2..d88aa8b3d 100644 --- a/docs/operations/bulkremoveworkspacemembersglobals.mdx +++ b/docs/operations/bulkremoveworkspacemembersglobals.mdx @@ -6,6 +6,6 @@ title: "BulkRemoveWorkspaceMembersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkremoveworkspacemembersrequest.mdx b/docs/operations/bulkremoveworkspacemembersrequest.mdx index 40b348890..9a3ec4bb7 100644 --- a/docs/operations/bulkremoveworkspacemembersrequest.mdx +++ b/docs/operations/bulkremoveworkspacemembersrequest.mdx @@ -6,8 +6,8 @@ title: "BulkRemoveWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulk_remove_workspace_members_request` | [components.BulkRemoveWorkspaceMembersRequest](../components/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `bulk_remove_workspace_members_request` | [components.BulkRemoveWorkspaceMembersRequest](../components/bulkremoveworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/operations/bulkunassignkeysfromguardrailglobals.mdx b/docs/operations/bulkunassignkeysfromguardrailglobals.mdx index 0fee944ad..2597202bd 100644 --- a/docs/operations/bulkunassignkeysfromguardrailglobals.mdx +++ b/docs/operations/bulkunassignkeysfromguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "BulkUnassignKeysFromGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkunassignkeysfromguardrailrequest.mdx b/docs/operations/bulkunassignkeysfromguardrailrequest.mdx index fba4dbe77..0e65d86de 100644 --- a/docs/operations/bulkunassignkeysfromguardrailrequest.mdx +++ b/docs/operations/bulkunassignkeysfromguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "BulkUnassignKeysFromGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_unassign_keys_request` | [components.BulkUnassignKeysRequest](../components/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulk_unassign_keys_request` | [components.BulkUnassignKeysRequest](../components/bulkunassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/operations/bulkunassignmembersfromguardrailglobals.mdx b/docs/operations/bulkunassignmembersfromguardrailglobals.mdx index e21cf59f2..982423acc 100644 --- a/docs/operations/bulkunassignmembersfromguardrailglobals.mdx +++ b/docs/operations/bulkunassignmembersfromguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "BulkUnassignMembersFromGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/bulkunassignmembersfromguardrailrequest.mdx b/docs/operations/bulkunassignmembersfromguardrailrequest.mdx index de22a4c7b..0c20f96d7 100644 --- a/docs/operations/bulkunassignmembersfromguardrailrequest.mdx +++ b/docs/operations/bulkunassignmembersfromguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "BulkUnassignMembersFromGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_unassign_members_request` | [components.BulkUnassignMembersRequest](../components/bulkunassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulk_unassign_members_request` | [components.BulkUnassignMembersRequest](../components/bulkunassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/operations/classifierdimensions.mdx b/docs/operations/classifierdimensions.mdx index f7cf34faf..ee620164f 100644 --- a/docs/operations/classifierdimensions.mdx +++ b/docs/operations/classifierdimensions.mdx @@ -9,6 +9,6 @@ Group results by custom classifier tags, breaking down metrics by the specified | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `classifier_id` | *str* | :heavy_check_mark: | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | -| `dimension_names` | List[*str*] | :heavy_minus_sign: | N/A | | -| `include_nulls` | *Optional[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 +| `classifier_id` | *str* | ✅ | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | +| `dimension_names` | List[*str*] | ➖ | N/A | | +| `include_nulls` | *Optional[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/operations/classifierfilters.mdx b/docs/operations/classifierfilters.mdx index db4dbe946..881b0849b 100644 --- a/docs/operations/classifierfilters.mdx +++ b/docs/operations/classifierfilters.mdx @@ -9,5 +9,5 @@ Filter results to generations with specific classifier tag values. Can be combin | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `classifier_id` | *str* | :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` | List[[operations.ClassifierFiltersFilter](../operations/classifierfiltersfilter.mdx)] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `classifier_id` | *str* | ✅ | 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` | List[[operations.ClassifierFiltersFilter](../operations/classifierfiltersfilter.mdx)] | ✅ | N/A | | \ No newline at end of file diff --git a/docs/operations/classifierfiltersfilter.mdx b/docs/operations/classifierfiltersfilter.mdx index f09e983a0..01ce09fe2 100644 --- a/docs/operations/classifierfiltersfilter.mdx +++ b/docs/operations/classifierfiltersfilter.mdx @@ -6,6 +6,6 @@ title: "ClassifierFiltersFilter" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field` | *str* | :heavy_check_mark: | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | -| `operator` | *str* | :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](../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` | *str* | ✅ | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | +| `operator` | *str* | ✅ | 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](../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/operations/contentimageurl.mdx b/docs/operations/contentimageurl.mdx index d0e186ad1..7a5b2a7b9 100644 --- a/docs/operations/contentimageurl.mdx +++ b/docs/operations/contentimageurl.mdx @@ -6,5 +6,5 @@ title: "ContentImageURL" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `image_url` | [operations.ImageURL](../operations/imageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [operations.TypeImageURL](../operations/typeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `image_url` | [operations.ImageURL](../operations/imageurl.mdx) | ✅ | N/A | +| `type` | [operations.TypeImageURL](../operations/typeimageurl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/contenttext.mdx b/docs/operations/contenttext.mdx index 08e418f7b..286bcb97e 100644 --- a/docs/operations/contenttext.mdx +++ b/docs/operations/contenttext.mdx @@ -6,5 +6,5 @@ title: "ContentText" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [operations.TypeText](../operations/typetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *str* | ✅ | N/A | +| `type` | [operations.TypeText](../operations/typetext.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/copyvaultsecretstointernglobals.mdx b/docs/operations/copyvaultsecretstointernglobals.mdx index 56423f3ad..6d6b8b426 100644 --- a/docs/operations/copyvaultsecretstointernglobals.mdx +++ b/docs/operations/copyvaultsecretstointernglobals.mdx @@ -6,6 +6,6 @@ title: "CopyVaultSecretsToInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/copyvaultsecretstointernrequest.mdx b/docs/operations/copyvaultsecretstointernrequest.mdx index 17c655cf0..892f9eb51 100644 --- a/docs/operations/copyvaultsecretstointernrequest.mdx +++ b/docs/operations/copyvaultsecretstointernrequest.mdx @@ -6,8 +6,8 @@ title: "CopyVaultSecretsToInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `vault_secret_copy_request` | [components.VaultSecretCopyRequest](../components/vaultsecretcopyrequest.mdx) | :heavy_check_mark: | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `vault_secret_copy_request` | [components.VaultSecretCopyRequest](../components/vaultsecretcopyrequest.mdx) | ✅ | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file diff --git a/docs/operations/createapialphadecisionsglobals.mdx b/docs/operations/createapialphadecisionsglobals.mdx index 2fc93732f..35ed6138c 100644 --- a/docs/operations/createapialphadecisionsglobals.mdx +++ b/docs/operations/createapialphadecisionsglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAPIAlphaDecisionsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createapialphadecisionsrequest.mdx b/docs/operations/createapialphadecisionsrequest.mdx index efdf720f6..153a9786f 100644 --- a/docs/operations/createapialphadecisionsrequest.mdx +++ b/docs/operations/createapialphadecisionsrequest.mdx @@ -6,7 +6,7 @@ title: "CreateAPIAlphaDecisionsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `decisions_request` | [components.DecisionsRequest](../components/decisionsrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `decisions_request` | [components.DecisionsRequest](../components/decisionsrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/createaudiospeechglobals.mdx b/docs/operations/createaudiospeechglobals.mdx index 78fe3a35c..a2404fcab 100644 --- a/docs/operations/createaudiospeechglobals.mdx +++ b/docs/operations/createaudiospeechglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAudioSpeechGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createaudiospeechrequest.mdx b/docs/operations/createaudiospeechrequest.mdx index a9aaac38a..2b933a1f8 100644 --- a/docs/operations/createaudiospeechrequest.mdx +++ b/docs/operations/createaudiospeechrequest.mdx @@ -6,7 +6,7 @@ title: "CreateAudioSpeechRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `speech_request` | [components.SpeechRequest](../components/speechrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": "Hello world",
"model": "mistralai/voxtral-mini-tts-2603",
"response_format": "pcm",
"speed": 1,
"voice": "en_paul_neutral"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `speech_request` | [components.SpeechRequest](../components/speechrequest.mdx) | ✅ | N/A | \{
"input": "Hello world",
"model": "mistralai/voxtral-mini-tts-2603",
"response_format": "pcm",
"speed": 1,
"voice": "en_paul_neutral"
} | \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsglobals.mdx b/docs/operations/createaudiotranscriptionsglobals.mdx index 2427dcaa5..5b1e0b2bb 100644 --- a/docs/operations/createaudiotranscriptionsglobals.mdx +++ b/docs/operations/createaudiotranscriptionsglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAudioTranscriptionsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsmultipartfile.mdx b/docs/operations/createaudiotranscriptionsmultipartfile.mdx index 3fa3d99a9..aed4e7f79 100644 --- a/docs/operations/createaudiotranscriptionsmultipartfile.mdx +++ b/docs/operations/createaudiotranscriptionsmultipartfile.mdx @@ -6,6 +6,6 @@ title: "CreateAudioTranscriptionsMultipartFile" | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `file_name` | *str* | :heavy_check_mark: | N/A | -| `content` | *Union[bytes, IO[bytes], io.IOBase]* | :heavy_check_mark: | N/A | -| `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `file_name` | *str* | ✅ | N/A | +| `content` | *Union[bytes, IO[bytes], io.IOBase]* | ✅ | N/A | +| `content_type` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsmultipartglobals.mdx b/docs/operations/createaudiotranscriptionsmultipartglobals.mdx index 40d3f1222..701bc6259 100644 --- a/docs/operations/createaudiotranscriptionsmultipartglobals.mdx +++ b/docs/operations/createaudiotranscriptionsmultipartglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAudioTranscriptionsMultipartGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsmultipartrequest.mdx b/docs/operations/createaudiotranscriptionsmultipartrequest.mdx index b5031668e..06e96faa3 100644 --- a/docs/operations/createaudiotranscriptionsmultipartrequest.mdx +++ b/docs/operations/createaudiotranscriptionsmultipartrequest.mdx @@ -6,7 +6,7 @@ title: "CreateAudioTranscriptionsMultipartRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `request_body` | [operations.CreateAudioTranscriptionsMultipartRequestBody](../operations/createaudiotranscriptionsmultipartrequestbody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `request_body` | [operations.CreateAudioTranscriptionsMultipartRequestBody](../operations/createaudiotranscriptionsmultipartrequestbody.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/createaudiotranscriptionsmultipartrequestbody.mdx b/docs/operations/createaudiotranscriptionsmultipartrequestbody.mdx index 784fc7b0f..08284aaa6 100644 --- a/docs/operations/createaudiotranscriptionsmultipartrequestbody.mdx +++ b/docs/operations/createaudiotranscriptionsmultipartrequestbody.mdx @@ -6,16 +6,16 @@ title: "CreateAudioTranscriptionsMultipartRequestBody" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `diarize` | *Optional[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` | [Optional[operations.CreateAudioTranscriptionsMultipartFile]](../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` | List[*str*] | :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` | *Optional[str]* | :heavy_minus_sign: | The language of the input audio (ISO-639-1). | -| `model` | *str* | :heavy_check_mark: | The model to use for transcription. | -| `provider` | *Optional[str]* | :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. | -| `response_format` | [Optional[operations.ResponseFormat]](../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). | -| `session_id` | *Optional[str]* | :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. | -| `source_url` | *Optional[str]* | :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` | *Optional[float]* | :heavy_minus_sign: | The sampling temperature. | -| `timestamp_granularities` | List[[operations.TimestampGranularities](../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` | *Optional[str]* | :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` | *Optional[str]* | :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` | *Optional[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` | [Optional[operations.CreateAudioTranscriptionsMultipartFile]](../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` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | The language of the input audio (ISO-639-1). | +| `model` | *str* | ✅ | The model to use for transcription. | +| `provider` | *Optional[str]* | ➖ | 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. | +| `response_format` | [Optional[operations.ResponseFormat]](../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). | +| `session_id` | *Optional[str]* | ➖ | 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. | +| `source_url` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | The sampling temperature. | +| `timestamp_granularities` | List[[operations.TimestampGranularities](../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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/operations/createaudiotranscriptionsrequest.mdx b/docs/operations/createaudiotranscriptionsrequest.mdx index 63faa868b..4774c6ed6 100644 --- a/docs/operations/createaudiotranscriptionsrequest.mdx +++ b/docs/operations/createaudiotranscriptionsrequest.mdx @@ -6,7 +6,7 @@ title: "CreateAudioTranscriptionsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `stt_request` | [components.STTRequest](../components/sttrequest.mdx) | :heavy_check_mark: | N/A | \{
"input_audio": \{
"data": "UklGRiQA...",
"format": "wav"
},
"language": "en",
"model": "openai/whisper-large-v3"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `stt_request` | [components.STTRequest](../components/sttrequest.mdx) | ✅ | N/A | \{
"input_audio": \{
"data": "UklGRiQA...",
"format": "wav"
},
"language": "en",
"model": "openai/whisper-large-v3"
} | \ No newline at end of file diff --git a/docs/operations/createauthkeyscodedata.mdx b/docs/operations/createauthkeyscodedata.mdx index 7089ba199..01c6f5f53 100644 --- a/docs/operations/createauthkeyscodedata.mdx +++ b/docs/operations/createauthkeyscodedata.mdx @@ -9,6 +9,6 @@ Auth code data | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `app_id` | *int* | :heavy_check_mark: | The application ID associated with this auth code | 12345 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | -| `id` | *str* | :heavy_check_mark: | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file +| `app_id` | *int* | ✅ | The application ID associated with this auth code | 12345 | +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | +| `id` | *str* | ✅ | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file diff --git a/docs/operations/createauthkeyscodeglobals.mdx b/docs/operations/createauthkeyscodeglobals.mdx index 4332a2403..adbbf2d91 100644 --- a/docs/operations/createauthkeyscodeglobals.mdx +++ b/docs/operations/createauthkeyscodeglobals.mdx @@ -6,6 +6,6 @@ title: "CreateAuthKeysCodeGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createauthkeyscoderequest.mdx b/docs/operations/createauthkeyscoderequest.mdx index cdafce622..e3aa5efe2 100644 --- a/docs/operations/createauthkeyscoderequest.mdx +++ b/docs/operations/createauthkeyscoderequest.mdx @@ -6,7 +6,7 @@ title: "CreateAuthKeysCodeRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateAuthKeysCodeRequestBody](../operations/createauthkeyscoderequestbody.mdx) | :heavy_check_mark: | N/A | \{
"callback_url": "https://myapp.com/auth/callback",
"code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM",
"code_challenge_method": "S256",
"limit": 100
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.CreateAuthKeysCodeRequestBody](../operations/createauthkeyscoderequestbody.mdx) | ✅ | N/A | \{
"callback_url": "https://myapp.com/auth/callback",
"code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM",
"code_challenge_method": "S256",
"limit": 100
} | \ No newline at end of file diff --git a/docs/operations/createauthkeyscoderequestbody.mdx b/docs/operations/createauthkeyscoderequestbody.mdx index 8d91bb3f3..a083a0ba0 100644 --- a/docs/operations/createauthkeyscoderequestbody.mdx +++ b/docs/operations/createauthkeyscoderequestbody.mdx @@ -6,11 +6,11 @@ title: "CreateAuthKeysCodeRequestBody" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `callback_url` | *str* | :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 | -| `code_challenge` | *Optional[str]* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../operations/createauthkeyscodecodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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 | -| `key_label` | *Optional[str]* | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | -| `limit` | *Optional[float]* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `usage_limit_type` | [Optional[operations.UsageLimitType]](../operations/usagelimittype.mdx) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to associate the API key with | | \ No newline at end of file +| `callback_url` | *str* | ✅ | 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 | +| `code_challenge` | *Optional[str]* | ➖ | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | +| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../operations/createauthkeyscodecodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | 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 | +| `key_label` | *Optional[str]* | ➖ | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | +| `limit` | *Optional[float]* | ➖ | Credit limit for the API key to be created | 100 | +| `usage_limit_type` | [Optional[operations.UsageLimitType]](../operations/usagelimittype.mdx) | ➖ | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | +| `workspace_id` | *Optional[str]* | ➖ | Optional workspace ID to associate the API key with | | \ No newline at end of file diff --git a/docs/operations/createauthkeyscoderesponse.mdx b/docs/operations/createauthkeyscoderesponse.mdx index 5044f5777..acff25e74 100644 --- a/docs/operations/createauthkeyscoderesponse.mdx +++ b/docs/operations/createauthkeyscoderesponse.mdx @@ -9,4 +9,4 @@ Successfully created authorization code | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `data` | [operations.CreateAuthKeysCodeData](../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](../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/operations/createbatchesglobals.mdx b/docs/operations/createbatchesglobals.mdx index 3fc8554f3..79969fac2 100644 --- a/docs/operations/createbatchesglobals.mdx +++ b/docs/operations/createbatchesglobals.mdx @@ -6,6 +6,6 @@ title: "CreateBatchesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createbatchesrequest.mdx b/docs/operations/createbatchesrequest.mdx index a809455bb..ebf930c1a 100644 --- a/docs/operations/createbatchesrequest.mdx +++ b/docs/operations/createbatchesrequest.mdx @@ -6,7 +6,7 @@ title: "CreateBatchesRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `batch_submit_body` | [components.BatchSubmitBody](../components/batchsubmitbody.mdx) | :heavy_check_mark: | The batch to create. Each item in `requests` has a unique `custom_id` and a `body` in the request format of the chosen `endpoint`. | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `batch_submit_body` | [components.BatchSubmitBody](../components/batchsubmitbody.mdx) | ✅ | The batch to create. Each item in `requests` has a unique `custom_id` and a `body` in the request format of the chosen `endpoint`. | \ No newline at end of file diff --git a/docs/operations/createbyokkeyglobals.mdx b/docs/operations/createbyokkeyglobals.mdx index 7a4e3e75e..775f6caeb 100644 --- a/docs/operations/createbyokkeyglobals.mdx +++ b/docs/operations/createbyokkeyglobals.mdx @@ -6,6 +6,6 @@ title: "CreateBYOKKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createbyokkeyrequest.mdx b/docs/operations/createbyokkeyrequest.mdx index f8b09da30..172b19af4 100644 --- a/docs/operations/createbyokkeyrequest.mdx +++ b/docs/operations/createbyokkeyrequest.mdx @@ -6,7 +6,7 @@ title: "CreateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_byok_key_request` | [components.CreateBYOKKeyRequest](../components/createbyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"key": "sk-proj-abc123...",
"name": "Production OpenAI Key",
"provider": "openai"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_byok_key_request` | [components.CreateBYOKKeyRequest](../components/createbyokkeyrequest.mdx) | ✅ | N/A | \{
"key": "sk-proj-abc123...",
"name": "Production OpenAI Key",
"provider": "openai"
} | \ No newline at end of file diff --git a/docs/operations/createembeddingsdata.mdx b/docs/operations/createembeddingsdata.mdx index 07670e00c..2bc84c96b 100644 --- a/docs/operations/createembeddingsdata.mdx +++ b/docs/operations/createembeddingsdata.mdx @@ -9,6 +9,6 @@ A single embedding object | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `embedding` | [operations.Embedding](../operations/embedding.mdx) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the embedding in the input list | 0 | -| `object` | [operations.ObjectEmbedding](../operations/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `embedding` | [operations.Embedding](../operations/embedding.mdx) | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `index` | *Optional[int]* | ➖ | Index of the embedding in the input list | 0 | +| `object` | [operations.ObjectEmbedding](../operations/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/operations/createembeddingsglobals.mdx b/docs/operations/createembeddingsglobals.mdx index 2325d62eb..1e7bd5590 100644 --- a/docs/operations/createembeddingsglobals.mdx +++ b/docs/operations/createembeddingsglobals.mdx @@ -6,6 +6,6 @@ title: "CreateEmbeddingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createembeddingsrequest.mdx b/docs/operations/createembeddingsrequest.mdx index 6d20f0154..22f6a5c0a 100644 --- a/docs/operations/createembeddingsrequest.mdx +++ b/docs/operations/createembeddingsrequest.mdx @@ -6,7 +6,7 @@ title: "CreateEmbeddingsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateEmbeddingsRequestBody](../operations/createembeddingsrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"dimensions": 1536,
"input": "The quick brown fox jumps over the lazy dog",
"model": "openai/text-embedding-3-small"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.CreateEmbeddingsRequestBody](../operations/createembeddingsrequestbody.mdx) | ✅ | N/A | \{
"dimensions": 1536,
"input": "The quick brown fox jumps over the lazy dog",
"model": "openai/text-embedding-3-small"
} | \ No newline at end of file diff --git a/docs/operations/createembeddingsrequestbody.mdx b/docs/operations/createembeddingsrequestbody.mdx index 80bb5d5af..30ca7a79f 100644 --- a/docs/operations/createembeddingsrequestbody.mdx +++ b/docs/operations/createembeddingsrequestbody.mdx @@ -9,12 +9,12 @@ Embeddings request input | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dimensions` | *Optional[int]* | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | -| `encoding_format` | [Optional[operations.EncodingFormat]](../operations/encodingformat.mdx) | :heavy_minus_sign: | The format of the output embeddings | float | -| `input` | [operations.InputUnion](../operations/inputunion.mdx) | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `input_type` | *Optional[str]* | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | -| `model` | *str* | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | :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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | \ No newline at end of file +| `dimensions` | *Optional[int]* | ➖ | The number of dimensions for the output embeddings | 1536 | +| `encoding_format` | [Optional[operations.EncodingFormat]](../operations/encodingformat.mdx) | ➖ | The format of the output embeddings | float | +| `input` | [operations.InputUnion](../operations/inputunion.mdx) | ✅ | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | +| `input_type` | *Optional[str]* | ➖ | The type of input (e.g. search_query, search_document) | search_query | +| `model` | *str* | ✅ | The model to use for embeddings | openai/text-embedding-3-small | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | ➖ | 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` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | A unique identifier for the end-user | user-1234 | \ No newline at end of file diff --git a/docs/operations/createembeddingsresponsebody.mdx b/docs/operations/createembeddingsresponsebody.mdx index 4efeda7aa..e16f95a89 100644 --- a/docs/operations/createembeddingsresponsebody.mdx +++ b/docs/operations/createembeddingsresponsebody.mdx @@ -9,8 +9,8 @@ Embeddings response containing embedding vectors | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | List[[operations.CreateEmbeddingsData](../operations/createembeddingsdata.mdx)] | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | -| `model` | *str* | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | -| `object` | [operations.Object](../operations/object.mdx) | :heavy_check_mark: | N/A | | -| `usage` | [Optional[operations.CreateEmbeddingsUsage]](../operations/createembeddingsusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `data` | List[[operations.CreateEmbeddingsData](../operations/createembeddingsdata.mdx)] | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `id` | *Optional[str]* | ➖ | Unique identifier for the embeddings response | embd-1234567890 | +| `model` | *str* | ✅ | The model used for embeddings | openai/text-embedding-3-small | +| `object` | [operations.Object](../operations/object.mdx) | ✅ | N/A | | +| `usage` | [Optional[operations.CreateEmbeddingsUsage]](../operations/createembeddingsusage.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file diff --git a/docs/operations/createembeddingsusage.mdx b/docs/operations/createembeddingsusage.mdx index 1218cf960..073e9202f 100644 --- a/docs/operations/createembeddingsusage.mdx +++ b/docs/operations/createembeddingsusage.mdx @@ -9,9 +9,9 @@ Token usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cost` | *Optional[float]* | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `cost_details` | [OptionalNullable[components.CostDetails]](../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
} | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `prompt_tokens` | *int* | :heavy_check_mark: | Number of tokens in the input | 8 | -| `prompt_tokens_details` | [Optional[operations.PromptTokensDetails]](../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. | | -| `total_tokens` | *int* | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file +| `cost` | *Optional[float]* | ➖ | Cost of the request in credits | 0.0001 | +| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `is_byok` | *Optional[bool]* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `prompt_tokens` | *int* | ✅ | Number of tokens in the input | 8 | +| `prompt_tokens_details` | [Optional[operations.PromptTokensDetails]](../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. | | +| `total_tokens` | *int* | ✅ | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/operations/createenduserglobals.mdx b/docs/operations/createenduserglobals.mdx index e420bbbee..e889ab3a4 100644 --- a/docs/operations/createenduserglobals.mdx +++ b/docs/operations/createenduserglobals.mdx @@ -6,6 +6,6 @@ title: "CreateEndUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createenduserrequest.mdx b/docs/operations/createenduserrequest.mdx index 9448f5084..90a760679 100644 --- a/docs/operations/createenduserrequest.mdx +++ b/docs/operations/createenduserrequest.mdx @@ -6,7 +6,7 @@ title: "CreateEndUserRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_end_user_request` | [components.CreateEndUserRequest](../components/createenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"user": "employee_123"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_end_user_request` | [components.CreateEndUserRequest](../components/createenduserrequest.mdx) | ✅ | N/A | \{
"user": "employee_123"
} | \ No newline at end of file diff --git a/docs/operations/createguardrailglobals.mdx b/docs/operations/createguardrailglobals.mdx index 89d6df049..9e71c1bd5 100644 --- a/docs/operations/createguardrailglobals.mdx +++ b/docs/operations/createguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "CreateGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createguardrailrequest.mdx b/docs/operations/createguardrailrequest.mdx index 645bf9a23..806a16bf9 100644 --- a/docs/operations/createguardrailrequest.mdx +++ b/docs/operations/createguardrailrequest.mdx @@ -6,7 +6,7 @@ title: "CreateGuardrailRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_guardrail_request` | [components.CreateGuardrailRequest](../components/createguardrailrequest.mdx) | :heavy_check_mark: | N/A | \{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"deepseek"
],
"content_filter_builtins": [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
],
"content_filters": null,
"description": "A guardrail for limiting API usage",
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"ignored_models": null,
"ignored_providers": null,
"limit_usd": 50,
"name": "My New Guardrail",
"reset_interval": "monthly"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_guardrail_request` | [components.CreateGuardrailRequest](../components/createguardrailrequest.mdx) | ✅ | N/A | \{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"deepseek"
],
"content_filter_builtins": [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
],
"content_filters": null,
"description": "A guardrail for limiting API usage",
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"ignored_models": null,
"ignored_providers": null,
"limit_usd": 50,
"name": "My New Guardrail",
"reset_interval": "monthly"
} | \ No newline at end of file diff --git a/docs/operations/createimagesglobals.mdx b/docs/operations/createimagesglobals.mdx index 98b5f6f8e..a6c441986 100644 --- a/docs/operations/createimagesglobals.mdx +++ b/docs/operations/createimagesglobals.mdx @@ -6,6 +6,6 @@ title: "CreateImagesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createimagesrequest.mdx b/docs/operations/createimagesrequest.mdx index 5e9a2d730..25813721c 100644 --- a/docs/operations/createimagesrequest.mdx +++ b/docs/operations/createimagesrequest.mdx @@ -6,7 +6,7 @@ title: "CreateImagesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `image_generation_request` | [components.ImageGenerationRequest](../components/imagegenerationrequest.mdx) | :heavy_check_mark: | N/A | \{
"model": "bytedance-seed/seedream-4.5",
"prompt": "a red panda astronaut floating in space, studio lighting"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `image_generation_request` | [components.ImageGenerationRequest](../components/imagegenerationrequest.mdx) | ✅ | N/A | \{
"model": "bytedance-seed/seedream-4.5",
"prompt": "a red panda astronaut floating in space, studio lighting"
} | \ No newline at end of file diff --git a/docs/operations/createinternchatcompletionglobals.mdx b/docs/operations/createinternchatcompletionglobals.mdx index 561b72c40..1c8248404 100644 --- a/docs/operations/createinternchatcompletionglobals.mdx +++ b/docs/operations/createinternchatcompletionglobals.mdx @@ -6,6 +6,6 @@ title: "CreateInternChatCompletionGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createinternchatcompletionrequest.mdx b/docs/operations/createinternchatcompletionrequest.mdx index a4bd48afd..bad5ae9c4 100644 --- a/docs/operations/createinternchatcompletionrequest.mdx +++ b/docs/operations/createinternchatcompletionrequest.mdx @@ -6,8 +6,8 @@ title: "CreateInternChatCompletionRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | -| `intern_chat_completion_request` | [components.InternChatCompletionRequest](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | +| `intern_chat_completion_request` | [components.InternChatCompletionRequest](../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/operations/createinternchatcompletionresponse.mdx b/docs/operations/createinternchatcompletionresponse.mdx index 6c0f59590..591187f24 100644 --- a/docs/operations/createinternchatcompletionresponse.mdx +++ b/docs/operations/createinternchatcompletionresponse.mdx @@ -6,5 +6,5 @@ title: "CreateInternChatCompletionResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | -| `result` | [operations.CreateInternChatCompletionResponseResult](../operations/createinternchatcompletionresponseresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `headers` | Dict[str, List[*str*]] | ✅ | N/A | +| `result` | [operations.CreateInternChatCompletionResponseResult](../operations/createinternchatcompletionresponseresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/createinternglobals.mdx b/docs/operations/createinternglobals.mdx index 8eb5e1fc3..f9f614160 100644 --- a/docs/operations/createinternglobals.mdx +++ b/docs/operations/createinternglobals.mdx @@ -6,6 +6,6 @@ title: "CreateInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createinternrequest.mdx b/docs/operations/createinternrequest.mdx index b3a223489..131f791d7 100644 --- a/docs/operations/createinternrequest.mdx +++ b/docs/operations/createinternrequest.mdx @@ -6,8 +6,8 @@ title: "CreateInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotency_key` | *Optional[str]* | :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 | -| `create_intern_request` | [components.CreateInternRequest](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotency_key` | *Optional[str]* | ➖ | 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 | +| `create_intern_request` | [components.CreateInternRequest](../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/operations/createkeysdata.mdx b/docs/operations/createkeysdata.mdx index 18bb520f7..0b1392e1f 100644 --- a/docs/operations/createkeysdata.mdx +++ b/docs/operations/createkeysdata.mdx @@ -9,26 +9,26 @@ The created API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | :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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `external_user` | *Nullable[str]* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creator_user_id` | *Nullable[str]* | ✅ | 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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `external_user` | *Nullable[str]* | ✅ | Partner's end-user identifier used for attribution. | null | +| `hash` | *str* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `label` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | +| `name` | *str* | ✅ | Name of the API key | My Production Key | +| `updated_at` | *Nullable[str]* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *str* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/operations/createkeysglobals.mdx b/docs/operations/createkeysglobals.mdx index 976d57a66..1fc891b1e 100644 --- a/docs/operations/createkeysglobals.mdx +++ b/docs/operations/createkeysglobals.mdx @@ -6,6 +6,6 @@ title: "CreateKeysGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createkeysrequest.mdx b/docs/operations/createkeysrequest.mdx index 9ec01bf61..4eaf6be4e 100644 --- a/docs/operations/createkeysrequest.mdx +++ b/docs/operations/createkeysrequest.mdx @@ -6,7 +6,7 @@ title: "CreateKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateKeysRequestBody](../operations/createkeysrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"expires_at": "2027-12-31T23:59:59Z",
"include_byok_in_limit": true,
"limit": 50,
"limit_reset": "monthly",
"name": "My New API Key"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.CreateKeysRequestBody](../operations/createkeysrequestbody.mdx) | ✅ | N/A | \{
"expires_at": "2027-12-31T23:59:59Z",
"include_byok_in_limit": true,
"limit": 50,
"limit_reset": "monthly",
"name": "My New API Key"
} | \ No newline at end of file diff --git a/docs/operations/createkeysrequestbody.mdx b/docs/operations/createkeysrequestbody.mdx index b07f92407..d9d0ab78f 100644 --- a/docs/operations/createkeysrequestbody.mdx +++ b/docs/operations/createkeysrequestbody.mdx @@ -6,11 +6,11 @@ title: "CreateKeysRequestBody" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `creator_user_id` | *OptionalNullable[str]* | :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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | [Optional[operations.External]](../operations/external.mdx) | :heavy_minus_sign: | Optional partner-defined identity associated with the created API key. | | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../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` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key | -| `workspace_id` | *Optional[str]* | :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 +| `creator_user_id` | *OptionalNullable[str]* | ➖ | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | 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` | [Optional[operations.External]](../operations/external.mdx) | ➖ | Optional partner-defined identity associated with the created API key. | | +| `include_byok_in_limit` | *Optional[bool]* | ➖ | Whether to include BYOK usage in the limit | true | +| `limit` | *OptionalNullable[float]* | ➖ | Optional spending limit for the API key in USD | 50 | +| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../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` | *str* | ✅ | Name for the new API key | My New API Key | +| `workspace_id` | *Optional[str]* | ➖ | 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/operations/createkeysresponse.mdx b/docs/operations/createkeysresponse.mdx index ef2250aec..f000615cd 100644 --- a/docs/operations/createkeysresponse.mdx +++ b/docs/operations/createkeysresponse.mdx @@ -9,5 +9,5 @@ API key created successfully | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateKeysData](../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` | *str* | :heavy_check_mark: | The actual API key string (only shown once) | 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 | \ No newline at end of file +| `data` | [operations.CreateKeysData](../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` | *str* | ✅ | The actual API key string (only shown once) | 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 | \ No newline at end of file diff --git a/docs/operations/createoauthtokenglobals.mdx b/docs/operations/createoauthtokenglobals.mdx index 5bf9b60d1..4e670bfed 100644 --- a/docs/operations/createoauthtokenglobals.mdx +++ b/docs/operations/createoauthtokenglobals.mdx @@ -6,6 +6,6 @@ title: "CreateOauthTokenGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createoauthtokenrequest.mdx b/docs/operations/createoauthtokenrequest.mdx index ce9fcd9ae..82d5dceb6 100644 --- a/docs/operations/createoauthtokenrequest.mdx +++ b/docs/operations/createoauthtokenrequest.mdx @@ -6,7 +6,7 @@ title: "CreateOauthTokenRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `token_exchange_request` | [components.TokenExchangeRequest](../components/tokenexchangerequest.mdx) | :heavy_check_mark: | N/A | \{
"federation_policy_id": "4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b",
"grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
"subject_token": "\u003cjwt from your identity provider\u003e",
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `token_exchange_request` | [components.TokenExchangeRequest](../components/tokenexchangerequest.mdx) | ✅ | N/A | \{
"federation_policy_id": "4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b",
"grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
"subject_token": "\u003cjwt from your identity provider\u003e",
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt"
} | \ No newline at end of file diff --git a/docs/operations/createobservabilitydestinationglobals.mdx b/docs/operations/createobservabilitydestinationglobals.mdx index 778aba142..a9917e497 100644 --- a/docs/operations/createobservabilitydestinationglobals.mdx +++ b/docs/operations/createobservabilitydestinationglobals.mdx @@ -6,6 +6,6 @@ title: "CreateObservabilityDestinationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createobservabilitydestinationrequest.mdx b/docs/operations/createobservabilitydestinationrequest.mdx index 3c62d6ca4..98af6502c 100644 --- a/docs/operations/createobservabilitydestinationrequest.mdx +++ b/docs/operations/createobservabilitydestinationrequest.mdx @@ -6,7 +6,7 @@ title: "CreateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_observability_destination_request` | [components.CreateObservabilityDestinationRequest](../components/createobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"name": "Production Langfuse",
"type": "langfuse"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_observability_destination_request` | [components.CreateObservabilityDestinationRequest](../components/createobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"name": "Production Langfuse",
"type": "langfuse"
} | \ No newline at end of file diff --git a/docs/operations/createpresetschatcompletionsglobals.mdx b/docs/operations/createpresetschatcompletionsglobals.mdx index 47f311158..f6af0e4e2 100644 --- a/docs/operations/createpresetschatcompletionsglobals.mdx +++ b/docs/operations/createpresetschatcompletionsglobals.mdx @@ -6,6 +6,6 @@ title: "CreatePresetsChatCompletionsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createpresetschatcompletionsrequest.mdx b/docs/operations/createpresetschatcompletionsrequest.mdx index c6bd78077..905ae6446 100644 --- a/docs/operations/createpresetschatcompletionsrequest.mdx +++ b/docs/operations/createpresetschatcompletionsrequest.mdx @@ -6,8 +6,8 @@ title: "CreatePresetsChatCompletionsRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `chat_request` | [components.ChatRequest](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `chat_request` | [components.ChatRequest](../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/operations/createpresetsmessagesglobals.mdx b/docs/operations/createpresetsmessagesglobals.mdx index 278c5d1f8..49374471b 100644 --- a/docs/operations/createpresetsmessagesglobals.mdx +++ b/docs/operations/createpresetsmessagesglobals.mdx @@ -6,6 +6,6 @@ title: "CreatePresetsMessagesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createpresetsmessagesrequest.mdx b/docs/operations/createpresetsmessagesrequest.mdx index 71d6249ed..62fe58670 100644 --- a/docs/operations/createpresetsmessagesrequest.mdx +++ b/docs/operations/createpresetsmessagesrequest.mdx @@ -6,8 +6,8 @@ title: "CreatePresetsMessagesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messages_request` | [components.MessagesRequest](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `messages_request` | [components.MessagesRequest](../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/operations/createpresetsresponsesglobals.mdx b/docs/operations/createpresetsresponsesglobals.mdx index 9d4fce86d..f410ec4d4 100644 --- a/docs/operations/createpresetsresponsesglobals.mdx +++ b/docs/operations/createpresetsresponsesglobals.mdx @@ -6,6 +6,6 @@ title: "CreatePresetsResponsesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createpresetsresponsesrequest.mdx b/docs/operations/createpresetsresponsesrequest.mdx index 54dde0eb3..e7b6d9c42 100644 --- a/docs/operations/createpresetsresponsesrequest.mdx +++ b/docs/operations/createpresetsresponsesrequest.mdx @@ -6,8 +6,8 @@ title: "CreatePresetsResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `responses_request` | [components.ResponsesRequest](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `responses_request` | [components.ResponsesRequest](../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/operations/createprivateendpointglobals.mdx b/docs/operations/createprivateendpointglobals.mdx index 700ae51c2..f59c981db 100644 --- a/docs/operations/createprivateendpointglobals.mdx +++ b/docs/operations/createprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "CreatePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createprivateendpointrequest.mdx b/docs/operations/createprivateendpointrequest.mdx index 175cee0cd..8039e542b 100644 --- a/docs/operations/createprivateendpointrequest.mdx +++ b/docs/operations/createprivateendpointrequest.mdx @@ -6,8 +6,8 @@ title: "CreatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotency_key` | *Optional[str]* | :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 | -| `create_private_endpoint_request` | [components.CreatePrivateEndpointRequest](../components/createprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotency_key` | *Optional[str]* | ➖ | 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 | +| `create_private_endpoint_request` | [components.CreatePrivateEndpointRequest](../components/createprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/operations/creatererankglobals.mdx b/docs/operations/creatererankglobals.mdx index e0e136ff2..01d7cf585 100644 --- a/docs/operations/creatererankglobals.mdx +++ b/docs/operations/creatererankglobals.mdx @@ -6,6 +6,6 @@ title: "CreateRerankGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/creatererankrequest.mdx b/docs/operations/creatererankrequest.mdx index f0d351fc5..992b7e157 100644 --- a/docs/operations/creatererankrequest.mdx +++ b/docs/operations/creatererankrequest.mdx @@ -6,7 +6,7 @@ title: "CreateRerankRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateRerankRequestBody](../operations/creatererankrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"documents": [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
],
"model": "cohere/rerank-v3.5",
"query": "What is the capital of France?",
"top_n": 3
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.CreateRerankRequestBody](../operations/creatererankrequestbody.mdx) | ✅ | N/A | \{
"documents": [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
],
"model": "cohere/rerank-v3.5",
"query": "What is the capital of France?",
"top_n": 3
} | \ No newline at end of file diff --git a/docs/operations/creatererankrequestbody.mdx b/docs/operations/creatererankrequestbody.mdx index f1021ad1c..476f2bd73 100644 --- a/docs/operations/creatererankrequestbody.mdx +++ b/docs/operations/creatererankrequestbody.mdx @@ -9,11 +9,11 @@ Rerank request input | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `documents` | List[[operations.Document](../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` | *str* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `query` | *str* | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | -| `session_id` | *Optional[str]* | :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 | -| `top_n` | *Optional[int]* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | -| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | :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` | List[[operations.Document](../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` | *str* | ✅ | The rerank model to use | cohere/rerank-v3.5 | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `query` | *str* | ✅ | The search query to rerank documents against | What is the capital of France? | +| `session_id` | *Optional[str]* | ➖ | 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 | +| `top_n` | *Optional[int]* | ➖ | Number of most relevant documents to return | 3 | +| `trace` | [Optional[components.TraceConfig]](../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` | *Optional[str]* | ➖ | 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/operations/creatererankresponsebody.mdx b/docs/operations/creatererankresponsebody.mdx index 9dc87532b..3df8a615e 100644 --- a/docs/operations/creatererankresponsebody.mdx +++ b/docs/operations/creatererankresponsebody.mdx @@ -9,8 +9,8 @@ Rerank response containing ranked results | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | -| `model` | *str* | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 | -| `provider` | *Optional[str]* | :heavy_minus_sign: | The provider that served the rerank request | Cohere | -| `results` | List[[operations.Result](../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` | [Optional[operations.CreateRerankUsage]](../operations/creatererankusage.mdx) | :heavy_minus_sign: | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file +| `id` | *Optional[str]* | ➖ | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | +| `model` | *str* | ✅ | The model used for reranking | cohere/rerank-v3.5 | +| `provider` | *Optional[str]* | ➖ | The provider that served the rerank request | Cohere | +| `results` | List[[operations.Result](../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` | [Optional[operations.CreateRerankUsage]](../operations/creatererankusage.mdx) | ➖ | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file diff --git a/docs/operations/creatererankusage.mdx b/docs/operations/creatererankusage.mdx index 66beef7ea..a10d64e26 100644 --- a/docs/operations/creatererankusage.mdx +++ b/docs/operations/creatererankusage.mdx @@ -9,6 +9,6 @@ Usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `cost` | *Optional[float]* | :heavy_minus_sign: | Cost of the request in credits | 0.001 | -| `search_units` | *Optional[int]* | :heavy_minus_sign: | Number of search units consumed (Cohere billing) | 1 | -| `total_tokens` | *Optional[int]* | :heavy_minus_sign: | Total number of tokens used | 150 | \ No newline at end of file +| `cost` | *Optional[float]* | ➖ | Cost of the request in credits | 0.001 | +| `search_units` | *Optional[int]* | ➖ | Number of search units consumed (Cohere billing) | 1 | +| `total_tokens` | *Optional[int]* | ➖ | Total number of tokens used | 150 | \ No newline at end of file diff --git a/docs/operations/createresponsesglobals.mdx b/docs/operations/createresponsesglobals.mdx index 60b3ee5d2..01ef20258 100644 --- a/docs/operations/createresponsesglobals.mdx +++ b/docs/operations/createresponsesglobals.mdx @@ -6,6 +6,6 @@ title: "CreateResponsesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createresponsesrequest.mdx b/docs/operations/createresponsesrequest.mdx index bd72e62c2..c71432404 100644 --- a/docs/operations/createresponsesrequest.mdx +++ b/docs/operations/createresponsesrequest.mdx @@ -6,8 +6,8 @@ title: "CreateResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../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 | -| `responses_request` | [components.ResponsesRequest](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../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 | +| `responses_request` | [components.ResponsesRequest](../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/operations/createscimgroupmappingglobals.mdx b/docs/operations/createscimgroupmappingglobals.mdx index ee1187f7f..30306ae2c 100644 --- a/docs/operations/createscimgroupmappingglobals.mdx +++ b/docs/operations/createscimgroupmappingglobals.mdx @@ -6,6 +6,6 @@ title: "CreateScimGroupMappingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createscimgroupmappingrequest.mdx b/docs/operations/createscimgroupmappingrequest.mdx index c5b268ab4..6273a9d78 100644 --- a/docs/operations/createscimgroupmappingrequest.mdx +++ b/docs/operations/createscimgroupmappingrequest.mdx @@ -6,7 +6,7 @@ title: "CreateScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `create_scim_group_mapping_request` | [components.CreateScimGroupMappingRequest](../components/createscimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `create_scim_group_mapping_request` | [components.CreateScimGroupMappingRequest](../components/createscimgroupmappingrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/createscimsyncjobglobals.mdx b/docs/operations/createscimsyncjobglobals.mdx index 5a954d8d9..7a32a00bc 100644 --- a/docs/operations/createscimsyncjobglobals.mdx +++ b/docs/operations/createscimsyncjobglobals.mdx @@ -6,6 +6,6 @@ title: "CreateScimSyncJobGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createscimsyncjobrequest.mdx b/docs/operations/createscimsyncjobrequest.mdx index 46f2d75c1..4254d4dea 100644 --- a/docs/operations/createscimsyncjobrequest.mdx +++ b/docs/operations/createscimsyncjobrequest.mdx @@ -6,6 +6,6 @@ title: "CreateScimSyncJobRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createscimsyncjobresponse.mdx b/docs/operations/createscimsyncjobresponse.mdx index 1832b155e..da5848ef8 100644 --- a/docs/operations/createscimsyncjobresponse.mdx +++ b/docs/operations/createscimsyncjobresponse.mdx @@ -6,5 +6,5 @@ title: "CreateScimSyncJobResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | -| `result` | [components.CreateScimSyncJobResponse](../components/createscimsyncjobresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `headers` | Dict[str, List[*str*]] | ✅ | N/A | +| `result` | [components.CreateScimSyncJobResponse](../components/createscimsyncjobresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/createsystemoneglobals.mdx b/docs/operations/createsystemoneglobals.mdx index 6fde4d643..94cdba60a 100644 --- a/docs/operations/createsystemoneglobals.mdx +++ b/docs/operations/createsystemoneglobals.mdx @@ -6,6 +6,6 @@ title: "CreateSystemoneGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createsystemonerequest.mdx b/docs/operations/createsystemonerequest.mdx index 434fb7f89..fb32393e8 100644 --- a/docs/operations/createsystemonerequest.mdx +++ b/docs/operations/createsystemonerequest.mdx @@ -6,7 +6,7 @@ title: "CreateSystemoneRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `decisions_request` | [components.DecisionsRequest](../components/decisionsrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `decisions_request` | [components.DecisionsRequest](../components/decisionsrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/createvideosglobals.mdx b/docs/operations/createvideosglobals.mdx index be83bcae4..67bd54e9b 100644 --- a/docs/operations/createvideosglobals.mdx +++ b/docs/operations/createvideosglobals.mdx @@ -6,6 +6,6 @@ title: "CreateVideosGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createvideosrequest.mdx b/docs/operations/createvideosrequest.mdx index 2bb242fb9..c79d703df 100644 --- a/docs/operations/createvideosrequest.mdx +++ b/docs/operations/createvideosrequest.mdx @@ -6,7 +6,7 @@ title: "CreateVideosRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `video_generation_request` | [components.VideoGenerationRequest](../components/videogenerationrequest.mdx) | :heavy_check_mark: | N/A | \{
"aspect_ratio": "16:9",
"duration": 8,
"model": "google/veo-3.1",
"prompt": "A serene mountain landscape at sunset",
"resolution": "720p"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `video_generation_request` | [components.VideoGenerationRequest](../components/videogenerationrequest.mdx) | ✅ | N/A | \{
"aspect_ratio": "16:9",
"duration": 8,
"model": "google/veo-3.1",
"prompt": "A serene mountain landscape at sunset",
"resolution": "720p"
} | \ No newline at end of file diff --git a/docs/operations/createworkspaceglobals.mdx b/docs/operations/createworkspaceglobals.mdx index c85655e73..ddce034c8 100644 --- a/docs/operations/createworkspaceglobals.mdx +++ b/docs/operations/createworkspaceglobals.mdx @@ -6,6 +6,6 @@ title: "CreateWorkspaceGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/createworkspacerequest.mdx b/docs/operations/createworkspacerequest.mdx index c4c5d7a85..cf085822c 100644 --- a/docs/operations/createworkspacerequest.mdx +++ b/docs/operations/createworkspacerequest.mdx @@ -6,7 +6,7 @@ title: "CreateWorkspaceRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_workspace_request` | [components.CreateWorkspaceRequest](../components/createworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"name": "Production",
"slug": "production"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `create_workspace_request` | [components.CreateWorkspaceRequest](../components/createworkspacerequest.mdx) | ✅ | N/A | \{
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"name": "Production",
"slug": "production"
} | \ No newline at end of file diff --git a/docs/operations/deletebatchglobals.mdx b/docs/operations/deletebatchglobals.mdx index ab6c9c87c..3bbe27823 100644 --- a/docs/operations/deletebatchglobals.mdx +++ b/docs/operations/deletebatchglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteBatchGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletebatchrequest.mdx b/docs/operations/deletebatchrequest.mdx index 4733d5e1c..407d7a96c 100644 --- a/docs/operations/deletebatchrequest.mdx +++ b/docs/operations/deletebatchrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteBatchRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/operations/deletebyokkeyglobals.mdx b/docs/operations/deletebyokkeyglobals.mdx index fa05fb4e1..dc9abf920 100644 --- a/docs/operations/deletebyokkeyglobals.mdx +++ b/docs/operations/deletebyokkeyglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteBYOKKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletebyokkeyrequest.mdx b/docs/operations/deletebyokkeyrequest.mdx index 7fdac9559..28b7cc22b 100644 --- a/docs/operations/deletebyokkeyrequest.mdx +++ b/docs/operations/deletebyokkeyrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/operations/deleteenduserglobals.mdx b/docs/operations/deleteenduserglobals.mdx index 07094eff6..82a6d0230 100644 --- a/docs/operations/deleteenduserglobals.mdx +++ b/docs/operations/deleteenduserglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteEndUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteenduserrequest.mdx b/docs/operations/deleteenduserrequest.mdx index 39556c28d..d26781bef 100644 --- a/docs/operations/deleteenduserrequest.mdx +++ b/docs/operations/deleteenduserrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `user` | *str* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `user` | *str* | ✅ | 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/operations/deletefileglobals.mdx b/docs/operations/deletefileglobals.mdx index 7cab840ae..e0c3809a7 100644 --- a/docs/operations/deletefileglobals.mdx +++ b/docs/operations/deletefileglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteFileGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletefilerequest.mdx b/docs/operations/deletefilerequest.mdx index acff81d0d..436907384 100644 --- a/docs/operations/deletefilerequest.mdx +++ b/docs/operations/deletefilerequest.mdx @@ -6,9 +6,9 @@ title: "DeleteFileRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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/operations/deleteguardrailglobals.mdx b/docs/operations/deleteguardrailglobals.mdx index 0c506f590..85fce122b 100644 --- a/docs/operations/deleteguardrailglobals.mdx +++ b/docs/operations/deleteguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteguardrailrequest.mdx b/docs/operations/deleteguardrailrequest.mdx index ba80054b8..2e11eee4c 100644 --- a/docs/operations/deleteguardrailrequest.mdx +++ b/docs/operations/deleteguardrailrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/operations/deleteinternglobals.mdx b/docs/operations/deleteinternglobals.mdx index fd39b2b51..52a4af8e7 100644 --- a/docs/operations/deleteinternglobals.mdx +++ b/docs/operations/deleteinternglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteinternrequest.mdx b/docs/operations/deleteinternrequest.mdx index 0ed033d7e..c4980d4d7 100644 --- a/docs/operations/deleteinternrequest.mdx +++ b/docs/operations/deleteinternrequest.mdx @@ -6,8 +6,8 @@ title: "DeleteInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `delete_intern_request` | [components.DeleteInternRequest](../components/deleteinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `delete_intern_request` | [components.DeleteInternRequest](../components/deleteinternrequest.mdx) | ✅ | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file diff --git a/docs/operations/deleteinternvaultsecretglobals.mdx b/docs/operations/deleteinternvaultsecretglobals.mdx index 4a262e0b4..2be53f3ba 100644 --- a/docs/operations/deleteinternvaultsecretglobals.mdx +++ b/docs/operations/deleteinternvaultsecretglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteInternVaultSecretGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteinternvaultsecretrequest.mdx b/docs/operations/deleteinternvaultsecretrequest.mdx index 2107702f7..1d5b9c794 100644 --- a/docs/operations/deleteinternvaultsecretrequest.mdx +++ b/docs/operations/deleteinternvaultsecretrequest.mdx @@ -6,8 +6,8 @@ title: "DeleteInternVaultSecretRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *str* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *str* | ✅ | 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/operations/deletekeysglobals.mdx b/docs/operations/deletekeysglobals.mdx index e89ca07d0..02bbb4ede 100644 --- a/docs/operations/deletekeysglobals.mdx +++ b/docs/operations/deletekeysglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteKeysGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletekeysrequest.mdx b/docs/operations/deletekeysrequest.mdx index f7ef7a946..5561fb7b8 100644 --- a/docs/operations/deletekeysrequest.mdx +++ b/docs/operations/deletekeysrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `hash` | *str* | ✅ | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/operations/deletekeysresponse.mdx b/docs/operations/deletekeysresponse.mdx index 5e83f2662..0dc0c3d83 100644 --- a/docs/operations/deletekeysresponse.mdx +++ b/docs/operations/deletekeysresponse.mdx @@ -9,4 +9,4 @@ API key deleted successfully | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file +| `deleted` | *Literal[True]* | ✅ | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/docs/operations/deleteobservabilitydestinationglobals.mdx b/docs/operations/deleteobservabilitydestinationglobals.mdx index 14ee5de06..b3aa547df 100644 --- a/docs/operations/deleteobservabilitydestinationglobals.mdx +++ b/docs/operations/deleteobservabilitydestinationglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteObservabilityDestinationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteobservabilitydestinationrequest.mdx b/docs/operations/deleteobservabilitydestinationrequest.mdx index 6dee392d1..dc61577c3 100644 --- a/docs/operations/deleteobservabilitydestinationrequest.mdx +++ b/docs/operations/deleteobservabilitydestinationrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/operations/deleteprivateendpointglobals.mdx b/docs/operations/deleteprivateendpointglobals.mdx index 8d1c1ca0e..633c4e34e 100644 --- a/docs/operations/deleteprivateendpointglobals.mdx +++ b/docs/operations/deleteprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "DeletePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteprivateendpointrequest.mdx b/docs/operations/deleteprivateendpointrequest.mdx index 81a137ab9..0adef6c76 100644 --- a/docs/operations/deleteprivateendpointrequest.mdx +++ b/docs/operations/deleteprivateendpointrequest.mdx @@ -6,8 +6,8 @@ title: "DeletePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `draft_only` | [Optional[operations.DraftOnly]](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `draft_only` | [Optional[operations.DraftOnly]](../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/operations/deletescimgroupmappingglobals.mdx b/docs/operations/deletescimgroupmappingglobals.mdx index 098b906f6..ad2a66e44 100644 --- a/docs/operations/deletescimgroupmappingglobals.mdx +++ b/docs/operations/deletescimgroupmappingglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteScimGroupMappingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletescimgroupmappingrequest.mdx b/docs/operations/deletescimgroupmappingrequest.mdx index 44e2e267a..6e2d4f52d 100644 --- a/docs/operations/deletescimgroupmappingrequest.mdx +++ b/docs/operations/deletescimgroupmappingrequest.mdx @@ -6,8 +6,8 @@ title: "DeleteScimGroupMappingRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `keep_members` | [operations.KeepMembers](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | N/A | | +| `keep_members` | [operations.KeepMembers](../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/operations/deletevaultsecretglobals.mdx b/docs/operations/deletevaultsecretglobals.mdx index 1e2f71a1e..c6c4e88b1 100644 --- a/docs/operations/deletevaultsecretglobals.mdx +++ b/docs/operations/deletevaultsecretglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteVaultSecretGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deletevaultsecretrequest.mdx b/docs/operations/deletevaultsecretrequest.mdx index ea844c458..e82e0862b 100644 --- a/docs/operations/deletevaultsecretrequest.mdx +++ b/docs/operations/deletevaultsecretrequest.mdx @@ -6,7 +6,7 @@ title: "DeleteVaultSecretRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `name` | *str* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `name` | *str* | ✅ | 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/operations/deleteworkspacebudgetglobals.mdx b/docs/operations/deleteworkspacebudgetglobals.mdx index f0aff8192..7e3c9dbc3 100644 --- a/docs/operations/deleteworkspacebudgetglobals.mdx +++ b/docs/operations/deleteworkspacebudgetglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteWorkspaceBudgetGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteworkspacebudgetrequest.mdx b/docs/operations/deleteworkspacebudgetrequest.mdx index 3470cc03c..d7188c892 100644 --- a/docs/operations/deleteworkspacebudgetrequest.mdx +++ b/docs/operations/deleteworkspacebudgetrequest.mdx @@ -6,8 +6,8 @@ title: "DeleteWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../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/operations/deleteworkspaceglobals.mdx b/docs/operations/deleteworkspaceglobals.mdx index c7f6f46cb..a08d49cb8 100644 --- a/docs/operations/deleteworkspaceglobals.mdx +++ b/docs/operations/deleteworkspaceglobals.mdx @@ -6,6 +6,6 @@ title: "DeleteWorkspaceGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/deleteworkspacerequest.mdx b/docs/operations/deleteworkspacerequest.mdx index abd7fdefd..ea77d6f6e 100644 --- a/docs/operations/deleteworkspacerequest.mdx +++ b/docs/operations/deleteworkspacerequest.mdx @@ -6,8 +6,8 @@ title: "DeleteWorkspaceRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `confirm_default_workspace_deletion` | *Optional[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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `confirm_default_workspace_deletion` | *Optional[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/operations/dimension.mdx b/docs/operations/dimension.mdx index 3659423d8..202615f87 100644 --- a/docs/operations/dimension.mdx +++ b/docs/operations/dimension.mdx @@ -6,5 +6,5 @@ title: "Dimension" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `display_label` | *str* | :heavy_check_mark: | Human-readable label | Model | -| `name` | *str* | :heavy_check_mark: | Dimension identifier used in query requests | model | \ No newline at end of file +| `display_label` | *str* | ✅ | Human-readable label | Model | +| `name` | *str* | ✅ | Dimension identifier used in query requests | model | \ No newline at end of file diff --git a/docs/operations/disableprivateendpointglobals.mdx b/docs/operations/disableprivateendpointglobals.mdx index 5ce04b276..6c3e78d7c 100644 --- a/docs/operations/disableprivateendpointglobals.mdx +++ b/docs/operations/disableprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "DisablePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/disableprivateendpointrequest.mdx b/docs/operations/disableprivateendpointrequest.mdx index a7188f2b0..41f3210a7 100644 --- a/docs/operations/disableprivateendpointrequest.mdx +++ b/docs/operations/disableprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "DisablePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/operations/documentrequest.mdx b/docs/operations/documentrequest.mdx index 4c0dd9f85..a152c2e2e 100644 --- a/docs/operations/documentrequest.mdx +++ b/docs/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` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | The document text | AI enables robots to perceive, plan, and act autonomously. | \ No newline at end of file +| `image` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | The document text | AI enables robots to perceive, plan, and act autonomously. | \ No newline at end of file diff --git a/docs/operations/documentresponse.mdx b/docs/operations/documentresponse.mdx index 5dc0d7b0c..13011de0c 100644 --- a/docs/operations/documentresponse.mdx +++ b/docs/operations/documentresponse.mdx @@ -9,5 +9,5 @@ The document object echoing the original input (text and/or image) | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `image` | *Optional[str]* | :heavy_minus_sign: | The image (URL or data URI) from the original document | https://example.com/image.png | -| `text` | *Optional[str]* | :heavy_minus_sign: | The document text | Paris is the capital of France. | \ No newline at end of file +| `image` | *Optional[str]* | ➖ | The image (URL or data URI) from the original document | https://example.com/image.png | +| `text` | *Optional[str]* | ➖ | The document text | Paris is the capital of France. | \ No newline at end of file diff --git a/docs/operations/downloadcontainerfilecontentglobals.mdx b/docs/operations/downloadcontainerfilecontentglobals.mdx index 630f5406b..35d8285d6 100644 --- a/docs/operations/downloadcontainerfilecontentglobals.mdx +++ b/docs/operations/downloadcontainerfilecontentglobals.mdx @@ -6,6 +6,6 @@ title: "DownloadContainerFileContentGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/downloadcontainerfilecontentrequest.mdx b/docs/operations/downloadcontainerfilecontentrequest.mdx index 19374f28d..86948d119 100644 --- a/docs/operations/downloadcontainerfilecontentrequest.mdx +++ b/docs/operations/downloadcontainerfilecontentrequest.mdx @@ -6,8 +6,8 @@ title: "DownloadContainerFileContentRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `container_id` | *str* | :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 | -| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `container_id` | *str* | ✅ | 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 | +| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/operations/downloadfilecontentglobals.mdx b/docs/operations/downloadfilecontentglobals.mdx index 8415a6685..653fff7e7 100644 --- a/docs/operations/downloadfilecontentglobals.mdx +++ b/docs/operations/downloadfilecontentglobals.mdx @@ -6,6 +6,6 @@ title: "DownloadFileContentGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/downloadfilecontentrequest.mdx b/docs/operations/downloadfilecontentrequest.mdx index 4e0f83f37..25e247b97 100644 --- a/docs/operations/downloadfilecontentrequest.mdx +++ b/docs/operations/downloadfilecontentrequest.mdx @@ -6,9 +6,9 @@ title: "DownloadFileContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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/operations/enableprivateendpointglobals.mdx b/docs/operations/enableprivateendpointglobals.mdx index 8ff7549f8..406f3f2ad 100644 --- a/docs/operations/enableprivateendpointglobals.mdx +++ b/docs/operations/enableprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "EnablePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/enableprivateendpointrequest.mdx b/docs/operations/enableprivateendpointrequest.mdx index 6ab00a007..1fa4075c1 100644 --- a/docs/operations/enableprivateendpointrequest.mdx +++ b/docs/operations/enableprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "EnablePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/operations/exchangeauthcodeforapikeyglobals.mdx b/docs/operations/exchangeauthcodeforapikeyglobals.mdx index 3e9fa3231..87e1d20d3 100644 --- a/docs/operations/exchangeauthcodeforapikeyglobals.mdx +++ b/docs/operations/exchangeauthcodeforapikeyglobals.mdx @@ -6,6 +6,6 @@ title: "ExchangeAuthCodeForAPIKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/exchangeauthcodeforapikeyrequest.mdx b/docs/operations/exchangeauthcodeforapikeyrequest.mdx index a52648cda..6638636d8 100644 --- a/docs/operations/exchangeauthcodeforapikeyrequest.mdx +++ b/docs/operations/exchangeauthcodeforapikeyrequest.mdx @@ -6,7 +6,7 @@ title: "ExchangeAuthCodeForAPIKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](../operations/exchangeauthcodeforapikeyrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"code": "auth_code_abc123def456",
"code_challenge_method": "S256",
"code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `request_body` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](../operations/exchangeauthcodeforapikeyrequestbody.mdx) | ✅ | N/A | \{
"code": "auth_code_abc123def456",
"code_challenge_method": "S256",
"code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"
} | \ No newline at end of file diff --git a/docs/operations/exchangeauthcodeforapikeyrequestbody.mdx b/docs/operations/exchangeauthcodeforapikeyrequestbody.mdx index 27265f4f7..0075cad86 100644 --- a/docs/operations/exchangeauthcodeforapikeyrequestbody.mdx +++ b/docs/operations/exchangeauthcodeforapikeyrequestbody.mdx @@ -6,6 +6,6 @@ title: "ExchangeAuthCodeForAPIKeyRequestBody" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `code` | *str* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `code_verifier` | *Optional[str]* | :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` | *str* | ✅ | The authorization code received from the OAuth redirect | auth_code_abc123def456 | +| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | +| `code_verifier` | *Optional[str]* | ➖ | 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/operations/exchangeauthcodeforapikeyresponse.mdx b/docs/operations/exchangeauthcodeforapikeyresponse.mdx index 2642f99d7..06952934b 100644 --- a/docs/operations/exchangeauthcodeforapikeyresponse.mdx +++ b/docs/operations/exchangeauthcodeforapikeyresponse.mdx @@ -9,5 +9,5 @@ Successfully exchanged code for an API key | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *str* | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | -| `user_id` | *Nullable[str]* | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file +| `key` | *str* | ✅ | The API key to use for OpenRouter requests | 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 | +| `user_id` | *Nullable[str]* | ✅ | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/docs/operations/external.mdx b/docs/operations/external.mdx index a9bac3e77..f8ac0a60f 100644 --- a/docs/operations/external.mdx +++ b/docs/operations/external.mdx @@ -9,5 +9,5 @@ Optional partner-defined identity associated with the created API key. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *Optional[str]* | :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` | *str* | :heavy_check_mark: | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file +| `api_key` | *Optional[str]* | ➖ | 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` | *str* | ✅ | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file diff --git a/docs/operations/filter_.mdx b/docs/operations/filter_.mdx index 8a0c5f32e..9ca17c1dc 100644 --- a/docs/operations/filter_.mdx +++ b/docs/operations/filter_.mdx @@ -6,7 +6,7 @@ title: "Filter" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field` | *str* | :heavy_check_mark: | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | -| `include_unset` | *Optional[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` | *str* | :heavy_check_mark: | Filter operator | eq | -| `value` | [operations.Value1](../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` | *str* | ✅ | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | +| `include_unset` | *Optional[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` | *str* | ✅ | Filter operator | eq | +| `value` | [operations.Value1](../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/operations/getanalyticsmetadata.mdx b/docs/operations/getanalyticsmetadata.mdx index 6eacfe52c..31d0a8f2e 100644 --- a/docs/operations/getanalyticsmetadata.mdx +++ b/docs/operations/getanalyticsmetadata.mdx @@ -6,7 +6,7 @@ title: "GetAnalyticsMetaData" | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `dimensions` | List[[operations.Dimension](../operations/dimension.mdx)] | :heavy_check_mark: | N/A | -| `granularities` | List[[operations.Granularity](../operations/granularity.mdx)] | :heavy_check_mark: | N/A | -| `metrics` | List[[operations.Metric](../operations/metric.mdx)] | :heavy_check_mark: | N/A | -| `operators` | List[[operations.Operator](../operations/operator.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `dimensions` | List[[operations.Dimension](../operations/dimension.mdx)] | ✅ | N/A | +| `granularities` | List[[operations.Granularity](../operations/granularity.mdx)] | ✅ | N/A | +| `metrics` | List[[operations.Metric](../operations/metric.mdx)] | ✅ | N/A | +| `operators` | List[[operations.Operator](../operations/operator.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/getanalyticsmetaglobals.mdx b/docs/operations/getanalyticsmetaglobals.mdx index a44950e11..79af35683 100644 --- a/docs/operations/getanalyticsmetaglobals.mdx +++ b/docs/operations/getanalyticsmetaglobals.mdx @@ -6,6 +6,6 @@ title: "GetAnalyticsMetaGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getanalyticsmetarequest.mdx b/docs/operations/getanalyticsmetarequest.mdx index 9ca0cb3d9..62cd80412 100644 --- a/docs/operations/getanalyticsmetarequest.mdx +++ b/docs/operations/getanalyticsmetarequest.mdx @@ -6,6 +6,6 @@ title: "GetAnalyticsMetaRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getanalyticsmetaresponse.mdx b/docs/operations/getanalyticsmetaresponse.mdx index f2a6915c1..6a659d4d9 100644 --- a/docs/operations/getanalyticsmetaresponse.mdx +++ b/docs/operations/getanalyticsmetaresponse.mdx @@ -9,4 +9,4 @@ Returns analytics query metadata | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | [operations.GetAnalyticsMetaData](../operations/getanalyticsmetadata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [operations.GetAnalyticsMetaData](../operations/getanalyticsmetadata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/getapprankingsglobals.mdx b/docs/operations/getapprankingsglobals.mdx index 0dd87c38f..7be3ca5ac 100644 --- a/docs/operations/getapprankingsglobals.mdx +++ b/docs/operations/getapprankingsglobals.mdx @@ -6,6 +6,6 @@ title: "GetAppRankingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getapprankingsrequest.mdx b/docs/operations/getapprankingsrequest.mdx index fb3afc125..28417333c 100644 --- a/docs/operations/getapprankingsrequest.mdx +++ b/docs/operations/getapprankingsrequest.mdx @@ -6,13 +6,13 @@ title: "GetAppRankingsRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `category` | [Optional[operations.GetAppRankingsCategory]](../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` | [Optional[operations.Subcategory]](../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` | [Optional[operations.GetAppRankingsSort]](../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 | -| `start_date` | *Optional[str]* | :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 | -| `end_date` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Maximum number of apps to return (1-100). Defaults to 50. | 50 | -| `offset` | *OptionalNullable[int]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `category` | [Optional[operations.GetAppRankingsCategory]](../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` | [Optional[operations.Subcategory]](../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` | [Optional[operations.GetAppRankingsSort]](../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 | +| `start_date` | *Optional[str]* | ➖ | 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 | +| `end_date` | *Optional[str]* | ➖ | 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` | *Optional[int]* | ➖ | Maximum number of apps to return (1-100). Defaults to 50. | 50 | +| `offset` | *OptionalNullable[int]* | ➖ | 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/operations/getapprankingsresponse.mdx b/docs/operations/getapprankingsresponse.mdx index 4d8e0195d..c7566188a 100644 --- a/docs/operations/getapprankingsresponse.mdx +++ b/docs/operations/getapprankingsresponse.mdx @@ -6,4 +6,4 @@ title: "GetAppRankingsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.AppRankingsResponse](../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](../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/operations/getbatchesglobals.mdx b/docs/operations/getbatchesglobals.mdx index 0f082c131..023896e2a 100644 --- a/docs/operations/getbatchesglobals.mdx +++ b/docs/operations/getbatchesglobals.mdx @@ -6,6 +6,6 @@ title: "GetBatchesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getbatchesrequest.mdx b/docs/operations/getbatchesrequest.mdx index 522a7e42a..93cb14bb4 100644 --- a/docs/operations/getbatchesrequest.mdx +++ b/docs/operations/getbatchesrequest.mdx @@ -6,7 +6,7 @@ title: "GetBatchesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/operations/getbenchmarksglobals.mdx b/docs/operations/getbenchmarksglobals.mdx index 679923bfb..274aa021a 100644 --- a/docs/operations/getbenchmarksglobals.mdx +++ b/docs/operations/getbenchmarksglobals.mdx @@ -6,6 +6,6 @@ title: "GetBenchmarksGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getbenchmarksrequest.mdx b/docs/operations/getbenchmarksrequest.mdx index e45dab262..ab720f00c 100644 --- a/docs/operations/getbenchmarksrequest.mdx +++ b/docs/operations/getbenchmarksrequest.mdx @@ -6,15 +6,15 @@ title: "GetBenchmarksRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `source` | [Optional[operations.Source]](../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 | -| `task_type` | [Optional[operations.TaskType]](../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 | -| `benchmark_type` | [Optional[operations.BenchmarkType]](../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 | -| `include_run_config` | *Optional[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 | -| `search_engine` | *Optional[str]* | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the search engine used. | exa | -| `search_surface` | [Optional[operations.SearchSurface]](../operations/searchsurface.mdx) | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | -| `arena` | [Optional[operations.Arena]](../operations/arena.mdx) | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | -| `category` | *Optional[str]* | :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 | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `source` | [Optional[operations.Source]](../operations/source.mdx) | ➖ | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | +| `task_type` | [Optional[operations.TaskType]](../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 | +| `benchmark_type` | [Optional[operations.BenchmarkType]](../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 | +| `include_run_config` | *Optional[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 | +| `search_engine` | *Optional[str]* | ➖ | OpenRouter search benchmarks only: filter by the search engine used. | exa | +| `search_surface` | [Optional[operations.SearchSurface]](../operations/searchsurface.mdx) | ➖ | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | +| `arena` | [Optional[operations.Arena]](../operations/arena.mdx) | ➖ | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | +| `category` | *Optional[str]* | ➖ | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | +| `max_results` | *Optional[int]* | ➖ | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file diff --git a/docs/operations/getbyokkeyglobals.mdx b/docs/operations/getbyokkeyglobals.mdx index 02962c394..4acf0c448 100644 --- a/docs/operations/getbyokkeyglobals.mdx +++ b/docs/operations/getbyokkeyglobals.mdx @@ -6,6 +6,6 @@ title: "GetBYOKKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getbyokkeyrequest.mdx b/docs/operations/getbyokkeyrequest.mdx index 7c2582129..7e3535935 100644 --- a/docs/operations/getbyokkeyrequest.mdx +++ b/docs/operations/getbyokkeyrequest.mdx @@ -6,7 +6,7 @@ title: "GetBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/operations/getcontainerfileglobals.mdx b/docs/operations/getcontainerfileglobals.mdx index 8343594f8..136824711 100644 --- a/docs/operations/getcontainerfileglobals.mdx +++ b/docs/operations/getcontainerfileglobals.mdx @@ -6,6 +6,6 @@ title: "GetContainerFileGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcontainerfilerequest.mdx b/docs/operations/getcontainerfilerequest.mdx index 1529bd94e..f93cbf450 100644 --- a/docs/operations/getcontainerfilerequest.mdx +++ b/docs/operations/getcontainerfilerequest.mdx @@ -6,8 +6,8 @@ title: "GetContainerFileRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `container_id` | *str* | :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 | -| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `container_id` | *str* | ✅ | 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 | +| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/operations/getcreditsdata.mdx b/docs/operations/getcreditsdata.mdx index b0a60e0c1..e530cf82c 100644 --- a/docs/operations/getcreditsdata.mdx +++ b/docs/operations/getcreditsdata.mdx @@ -6,5 +6,5 @@ title: "GetCreditsData" | Field | Type | Required | Description | Example | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `total_credits` | *float* | :heavy_check_mark: | Total credits purchased | 100.5 | -| `total_usage` | *float* | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file +| `total_credits` | *float* | ✅ | Total credits purchased | 100.5 | +| `total_usage` | *float* | ✅ | Total credits used | 25.75 | \ No newline at end of file diff --git a/docs/operations/getcreditsglobals.mdx b/docs/operations/getcreditsglobals.mdx index e31d9868d..6d68841f0 100644 --- a/docs/operations/getcreditsglobals.mdx +++ b/docs/operations/getcreditsglobals.mdx @@ -6,6 +6,6 @@ title: "GetCreditsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcreditsrequest.mdx b/docs/operations/getcreditsrequest.mdx index 6e73894ac..3480020e4 100644 --- a/docs/operations/getcreditsrequest.mdx +++ b/docs/operations/getcreditsrequest.mdx @@ -6,6 +6,6 @@ title: "GetCreditsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcreditsresponse.mdx b/docs/operations/getcreditsresponse.mdx index 1f584bb9e..281e71c1a 100644 --- a/docs/operations/getcreditsresponse.mdx +++ b/docs/operations/getcreditsresponse.mdx @@ -9,4 +9,4 @@ Total credits purchased and used | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `data` | [operations.GetCreditsData](../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](../operations/getcreditsdata.mdx) | ✅ | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file diff --git a/docs/operations/getcurrentkeydata.mdx b/docs/operations/getcurrentkeydata.mdx index 33b5cb77d..9edb39914 100644 --- a/docs/operations/getcurrentkeydata.mdx +++ b/docs/operations/getcurrentkeydata.mdx @@ -9,28 +9,28 @@ Current API key information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_data_regions` | List[[operations.AllowedDataRegion](../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"
] | -| `budgets` | List[[components.KeyBudget](../components/keybudget.mdx)] | :heavy_check_mark: | Every budget layer enforcement checks for requests made with this key, in the order it checks them: guardrail budgets, workspace budgets, then the key's own limit. Empty when nothing is budgeted. `effective_budget` is the budget that blocks requests first: the entry enforcement rejects on when one is already spent, otherwise the entry with the least `remaining_usd`; null when nothing is budgeted. `limit` and `limit_remaining` above describe only the key's own limit. | [
\{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
}
] | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `creator_user_id` | *Nullable[str]* | :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 | -| `effective_budget` | [Nullable[components.KeyBudget]](../components/keybudget.mdx) | :heavy_check_mark: | N/A | \{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
} | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `free_model_daily_requests` | [components.FreeModelDailyRequests](../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
} | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `is_free_tier` | *bool* | :heavy_check_mark: | Whether this is a free tier API key | false | -| `is_management_key` | *bool* | :heavy_check_mark: | Whether this is a management key | false | -| ~~`is_provisioning_key`~~ | *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` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `organization_id` | *Nullable[str]* | :heavy_check_mark: | The ID of the organization that owns this API key, or null when an individual account owns it. | null | -| ~~`rate_limit`~~ | [operations.RateLimit](../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` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *Nullable[str]* | :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 +| `allowed_data_regions` | List[[operations.AllowedDataRegion](../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"
] | +| `budgets` | List[[components.KeyBudget](../components/keybudget.mdx)] | ✅ | Every budget layer enforcement checks for requests made with this key, in the order it checks them: guardrail budgets, workspace budgets, then the key's own limit. Empty when nothing is budgeted. `effective_budget` is the budget that blocks requests first: the entry enforcement rejects on when one is already spent, otherwise the entry with the least `remaining_usd`; null when nothing is budgeted. `limit` and `limit_remaining` above describe only the key's own limit. | [
\{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
}
] | +| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `creator_user_id` | *Nullable[str]* | ✅ | 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 | +| `effective_budget` | [Nullable[components.KeyBudget]](../components/keybudget.mdx) | ✅ | N/A | \{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
} | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `free_model_daily_requests` | [components.FreeModelDailyRequests](../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
} | +| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `is_free_tier` | *bool* | ✅ | Whether this is a free tier API key | false | +| `is_management_key` | *bool* | ✅ | Whether this is a management key | false | +| ~~`is_provisioning_key`~~ | *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` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `limit` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | +| `organization_id` | *Nullable[str]* | ✅ | The ID of the organization that owns this API key, or null when an individual account owns it. | null | +| ~~`rate_limit`~~ | [operations.RateLimit](../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` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *Nullable[str]* | ✅ | 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/operations/getcurrentkeyglobals.mdx b/docs/operations/getcurrentkeyglobals.mdx index 784c3ac35..eeaa280d8 100644 --- a/docs/operations/getcurrentkeyglobals.mdx +++ b/docs/operations/getcurrentkeyglobals.mdx @@ -6,6 +6,6 @@ title: "GetCurrentKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcurrentkeyrequest.mdx b/docs/operations/getcurrentkeyrequest.mdx index 720e0e050..a0f691dec 100644 --- a/docs/operations/getcurrentkeyrequest.mdx +++ b/docs/operations/getcurrentkeyrequest.mdx @@ -6,6 +6,6 @@ title: "GetCurrentKeyRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getcurrentkeyresponse.mdx b/docs/operations/getcurrentkeyresponse.mdx index bf0f6a34d..3bb4a580b 100644 --- a/docs/operations/getcurrentkeyresponse.mdx +++ b/docs/operations/getcurrentkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetCurrentKeyData](../operations/getcurrentkeydata.mdx) | :heavy_check_mark: | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"budgets": [
\{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
}
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"effective_budget": \{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
},
"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](../operations/getcurrentkeydata.mdx) | ✅ | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"budgets": [
\{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
}
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"effective_budget": \{
"budget_id": null,
"guardrail_id": "0df9e665-d932-5740-b2c7-b52af166bc11",
"include_byok": false,
"limit_usd": 50,
"remaining_usd": 17.5,
"reset_interval": "weekly",
"resets_at": "2026-10-12T00:00:00.000Z",
"scope": "member",
"spend_usd": 32.5
},
"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/operations/getenduserglobals.mdx b/docs/operations/getenduserglobals.mdx index 9ec66ba16..2b3180e07 100644 --- a/docs/operations/getenduserglobals.mdx +++ b/docs/operations/getenduserglobals.mdx @@ -6,6 +6,6 @@ title: "GetEndUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getenduserrequest.mdx b/docs/operations/getenduserrequest.mdx index 1e234b288..51b72505b 100644 --- a/docs/operations/getenduserrequest.mdx +++ b/docs/operations/getenduserrequest.mdx @@ -6,7 +6,7 @@ title: "GetEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `user` | *str* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `user` | *str* | ✅ | 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/operations/getfilemetadataglobals.mdx b/docs/operations/getfilemetadataglobals.mdx index 4b9270d76..155391a10 100644 --- a/docs/operations/getfilemetadataglobals.mdx +++ b/docs/operations/getfilemetadataglobals.mdx @@ -6,6 +6,6 @@ title: "GetFileMetadataGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getfilemetadatarequest.mdx b/docs/operations/getfilemetadatarequest.mdx index 429a0f547..a3de05a5a 100644 --- a/docs/operations/getfilemetadatarequest.mdx +++ b/docs/operations/getfilemetadatarequest.mdx @@ -6,9 +6,9 @@ title: "GetFileMetadataRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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/operations/getgenerationglobals.mdx b/docs/operations/getgenerationglobals.mdx index 450a95a84..188c89473 100644 --- a/docs/operations/getgenerationglobals.mdx +++ b/docs/operations/getgenerationglobals.mdx @@ -6,6 +6,6 @@ title: "GetGenerationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getgenerationrequest.mdx b/docs/operations/getgenerationrequest.mdx index 318c98012..1164a497e 100644 --- a/docs/operations/getgenerationrequest.mdx +++ b/docs/operations/getgenerationrequest.mdx @@ -6,7 +6,7 @@ title: "GetGenerationRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/operations/getguardrailglobals.mdx b/docs/operations/getguardrailglobals.mdx index 3cd67137d..6b885f099 100644 --- a/docs/operations/getguardrailglobals.mdx +++ b/docs/operations/getguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "GetGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getguardrailrequest.mdx b/docs/operations/getguardrailrequest.mdx index 15bebf62b..3c44f43c1 100644 --- a/docs/operations/getguardrailrequest.mdx +++ b/docs/operations/getguardrailrequest.mdx @@ -6,7 +6,7 @@ title: "GetGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/operations/getinterndaemonaccessglobals.mdx b/docs/operations/getinterndaemonaccessglobals.mdx index 95abed7a1..d26998946 100644 --- a/docs/operations/getinterndaemonaccessglobals.mdx +++ b/docs/operations/getinterndaemonaccessglobals.mdx @@ -6,6 +6,6 @@ title: "GetInternDaemonAccessGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getinterndaemonaccessrequest.mdx b/docs/operations/getinterndaemonaccessrequest.mdx index e2035a9f0..169fa7676 100644 --- a/docs/operations/getinterndaemonaccessrequest.mdx +++ b/docs/operations/getinterndaemonaccessrequest.mdx @@ -6,7 +6,7 @@ title: "GetInternDaemonAccessRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | 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/operations/getinterndaemonglobals.mdx b/docs/operations/getinterndaemonglobals.mdx index b2ba0d173..5cb15c10c 100644 --- a/docs/operations/getinterndaemonglobals.mdx +++ b/docs/operations/getinterndaemonglobals.mdx @@ -6,6 +6,6 @@ title: "GetInternDaemonGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getinterndaemonrequest.mdx b/docs/operations/getinterndaemonrequest.mdx index cdfbaafc1..b21897206 100644 --- a/docs/operations/getinterndaemonrequest.mdx +++ b/docs/operations/getinterndaemonrequest.mdx @@ -6,7 +6,7 @@ title: "GetInternDaemonRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | 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/operations/getinternglobals.mdx b/docs/operations/getinternglobals.mdx index 118bb0d2f..a524a18a9 100644 --- a/docs/operations/getinternglobals.mdx +++ b/docs/operations/getinternglobals.mdx @@ -6,6 +6,6 @@ title: "GetInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getinternrequest.mdx b/docs/operations/getinternrequest.mdx index cd83fdf51..3b516a3b1 100644 --- a/docs/operations/getinternrequest.mdx +++ b/docs/operations/getinternrequest.mdx @@ -6,7 +6,7 @@ title: "GetInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | 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/operations/getkeydata.mdx b/docs/operations/getkeydata.mdx index 3ad8cfab8..f93cde1d0 100644 --- a/docs/operations/getkeydata.mdx +++ b/docs/operations/getkeydata.mdx @@ -9,26 +9,26 @@ The API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | :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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `external_user` | *Nullable[str]* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creator_user_id` | *Nullable[str]* | ✅ | 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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `external_user` | *Nullable[str]* | ✅ | Partner's end-user identifier used for attribution. | null | +| `hash` | *str* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `label` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | +| `name` | *str* | ✅ | Name of the API key | My Production Key | +| `updated_at` | *Nullable[str]* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *str* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/operations/getkeyglobals.mdx b/docs/operations/getkeyglobals.mdx index 59d0a567f..ebc8f56f3 100644 --- a/docs/operations/getkeyglobals.mdx +++ b/docs/operations/getkeyglobals.mdx @@ -6,6 +6,6 @@ title: "GetKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getkeyrequest.mdx b/docs/operations/getkeyrequest.mdx index 917f40732..3f13c8e29 100644 --- a/docs/operations/getkeyrequest.mdx +++ b/docs/operations/getkeyrequest.mdx @@ -6,7 +6,7 @@ title: "GetKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `hash` | *str* | ✅ | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/operations/getkeyresponse.mdx b/docs/operations/getkeyresponse.mdx index 962912273..2fb830051 100644 --- a/docs/operations/getkeyresponse.mdx +++ b/docs/operations/getkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetKeyData](../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](../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/operations/getmodelglobals.mdx b/docs/operations/getmodelglobals.mdx index e253e0265..66f24f7f1 100644 --- a/docs/operations/getmodelglobals.mdx +++ b/docs/operations/getmodelglobals.mdx @@ -6,6 +6,6 @@ title: "GetModelGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getmodelrequest.mdx b/docs/operations/getmodelrequest.mdx index 860150ab6..92fb4ee45 100644 --- a/docs/operations/getmodelrequest.mdx +++ b/docs/operations/getmodelrequest.mdx @@ -6,8 +6,8 @@ title: "GetModelRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | *str* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `author` | *str* | ✅ | The author/organization of the model | openai | +| `slug` | *str* | ✅ | 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/operations/getmodelsglobals.mdx b/docs/operations/getmodelsglobals.mdx index e6beafcf1..0f723aca8 100644 --- a/docs/operations/getmodelsglobals.mdx +++ b/docs/operations/getmodelsglobals.mdx @@ -6,6 +6,6 @@ title: "GetModelsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getmodelsrequest.mdx b/docs/operations/getmodelsrequest.mdx index 95e4b488f..720c6a15c 100644 --- a/docs/operations/getmodelsrequest.mdx +++ b/docs/operations/getmodelsrequest.mdx @@ -6,35 +6,35 @@ title: "GetModelsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | :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` | [Optional[operations.GetModelsCategory]](../operations/getmodelscategory.mdx) | :heavy_minus_sign: | Filter models by use case category | programming | -| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | -| `output_modalities` | *Optional[str]* | :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` | [Optional[operations.GetModelsSort]](../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` | *Optional[str]* | :heavy_minus_sign: | Free-text search by model name or slug. | gpt-4 | -| `input_modalities` | *Optional[str]* | :heavy_minus_sign: | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | -| `context` | *Optional[int]* | :heavy_minus_sign: | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | -| `min_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum prompt price in $/M tokens. | 0 | -| `max_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum prompt price in $/M tokens. | 10 | -| `arch` | *Optional[str]* | :heavy_minus_sign: | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | -| `model_authors` | *Optional[str]* | :heavy_minus_sign: | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | -| `providers` | *Optional[str]* | :heavy_minus_sign: | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | -| `distillable` | [Optional[operations.Distillable]](../operations/distillable.mdx) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | -| `zdr` | [Optional[operations.Zdr]](../operations/zdr.mdx) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | -| `region` | [Optional[operations.Region]](../operations/region.mdx) | :heavy_minus_sign: | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | -| `min_output_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum completion (output) price in $/M tokens. | 0 | -| `max_output_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum completion (output) price in $/M tokens. | 10 | -| `min_age_days` | *OptionalNullable[int]* | :heavy_minus_sign: | Minimum model age in days since its creation date. | 0 | -| `max_age_days` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum model age in days since its creation date. | 90 | -| `min_intelligence_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis intelligence index. | 50 | -| `max_intelligence_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis intelligence index. | 100 | -| `min_coding_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis coding index. | 50 | -| `max_coding_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis coding index. | 100 | -| `min_agentic_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis agentic index. | 50 | -| `max_agentic_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis agentic index. | 100 | -| `min_tool_success_rate` | *OptionalNullable[float]* | :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 | -| `max_tool_success_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `category` | [Optional[operations.GetModelsCategory]](../operations/getmodelscategory.mdx) | ➖ | Filter models by use case category | programming | +| `supported_parameters` | *Optional[str]* | ➖ | Filter models by supported parameter (comma-separated) | temperature | +| `output_modalities` | *Optional[str]* | ➖ | 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` | [Optional[operations.GetModelsSort]](../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` | *Optional[str]* | ➖ | Free-text search by model name or slug. | gpt-4 | +| `input_modalities` | *Optional[str]* | ➖ | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | +| `context` | *Optional[int]* | ➖ | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | +| `min_price` | *OptionalNullable[float]* | ➖ | Minimum prompt price in $/M tokens. | 0 | +| `max_price` | *OptionalNullable[float]* | ➖ | Maximum prompt price in $/M tokens. | 10 | +| `arch` | *Optional[str]* | ➖ | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | +| `model_authors` | *Optional[str]* | ➖ | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | +| `providers` | *Optional[str]* | ➖ | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | +| `distillable` | [Optional[operations.Distillable]](../operations/distillable.mdx) | ➖ | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | +| `zdr` | [Optional[operations.Zdr]](../operations/zdr.mdx) | ➖ | When set to "true", return only models with zero data retention endpoints. | true | +| `region` | [Optional[operations.Region]](../operations/region.mdx) | ➖ | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | +| `min_output_price` | *OptionalNullable[float]* | ➖ | Minimum completion (output) price in $/M tokens. | 0 | +| `max_output_price` | *OptionalNullable[float]* | ➖ | Maximum completion (output) price in $/M tokens. | 10 | +| `min_age_days` | *OptionalNullable[int]* | ➖ | Minimum model age in days since its creation date. | 0 | +| `max_age_days` | *OptionalNullable[int]* | ➖ | Maximum model age in days since its creation date. | 90 | +| `min_intelligence_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis intelligence index. | 50 | +| `max_intelligence_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis intelligence index. | 100 | +| `min_coding_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis coding index. | 50 | +| `max_coding_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis coding index. | 100 | +| `min_agentic_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis agentic index. | 50 | +| `max_agentic_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis agentic index. | 100 | +| `min_tool_success_rate` | *OptionalNullable[float]* | ➖ | 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 | +| `max_tool_success_rate` | *OptionalNullable[float]* | ➖ | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | \ No newline at end of file diff --git a/docs/operations/getmodelsresponse.mdx b/docs/operations/getmodelsresponse.mdx index c7353f31e..c420651f2 100644 --- a/docs/operations/getmodelsresponse.mdx +++ b/docs/operations/getmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "GetModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ModelsListResponse](../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](../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/operations/getobservabilitydestinationglobals.mdx b/docs/operations/getobservabilitydestinationglobals.mdx index aeec24b09..b7b80f3be 100644 --- a/docs/operations/getobservabilitydestinationglobals.mdx +++ b/docs/operations/getobservabilitydestinationglobals.mdx @@ -6,6 +6,6 @@ title: "GetObservabilityDestinationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getobservabilitydestinationrequest.mdx b/docs/operations/getobservabilitydestinationrequest.mdx index 39b2655a6..402163eaf 100644 --- a/docs/operations/getobservabilitydestinationrequest.mdx +++ b/docs/operations/getobservabilitydestinationrequest.mdx @@ -6,7 +6,7 @@ title: "GetObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/operations/getorganizationsettingsglobals.mdx b/docs/operations/getorganizationsettingsglobals.mdx index 0da74f3e2..d7b209aa8 100644 --- a/docs/operations/getorganizationsettingsglobals.mdx +++ b/docs/operations/getorganizationsettingsglobals.mdx @@ -6,6 +6,6 @@ title: "GetOrganizationSettingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getorganizationsettingsrequest.mdx b/docs/operations/getorganizationsettingsrequest.mdx index 81b959f54..89d9be99a 100644 --- a/docs/operations/getorganizationsettingsrequest.mdx +++ b/docs/operations/getorganizationsettingsrequest.mdx @@ -6,6 +6,6 @@ title: "GetOrganizationSettingsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getorganizationsettingsresponse.mdx b/docs/operations/getorganizationsettingsresponse.mdx index 240031a50..a43f8dab0 100644 --- a/docs/operations/getorganizationsettingsresponse.mdx +++ b/docs/operations/getorganizationsettingsresponse.mdx @@ -9,4 +9,4 @@ Organization settings | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [components.OrganizationSettings](../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](../components/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file diff --git a/docs/operations/getpresetglobals.mdx b/docs/operations/getpresetglobals.mdx index b3e3cb518..e1a943be0 100644 --- a/docs/operations/getpresetglobals.mdx +++ b/docs/operations/getpresetglobals.mdx @@ -6,6 +6,6 @@ title: "GetPresetGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getpresetrequest.mdx b/docs/operations/getpresetrequest.mdx index 373839890..671a7c545 100644 --- a/docs/operations/getpresetrequest.mdx +++ b/docs/operations/getpresetrequest.mdx @@ -6,7 +6,7 @@ title: "GetPresetRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file diff --git a/docs/operations/getpresetversionglobals.mdx b/docs/operations/getpresetversionglobals.mdx index 55879e9ba..dbabdd2fb 100644 --- a/docs/operations/getpresetversionglobals.mdx +++ b/docs/operations/getpresetversionglobals.mdx @@ -6,6 +6,6 @@ title: "GetPresetVersionGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getpresetversionrequest.mdx b/docs/operations/getpresetversionrequest.mdx index c7cf40110..627d573b1 100644 --- a/docs/operations/getpresetversionrequest.mdx +++ b/docs/operations/getpresetversionrequest.mdx @@ -6,8 +6,8 @@ title: "GetPresetVersionRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `version` | *str* | :heavy_check_mark: | Version number of the preset. | 1 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | +| `version` | *str* | ✅ | Version number of the preset. | 1 | \ No newline at end of file diff --git a/docs/operations/getprivateendpointglobals.mdx b/docs/operations/getprivateendpointglobals.mdx index 81ff79ea5..6c1d4444f 100644 --- a/docs/operations/getprivateendpointglobals.mdx +++ b/docs/operations/getprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "GetPrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getprivateendpointrequest.mdx b/docs/operations/getprivateendpointrequest.mdx index eb6aa4354..6f17bf5aa 100644 --- a/docs/operations/getprivateendpointrequest.mdx +++ b/docs/operations/getprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "GetPrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/operations/getrankingsdailyglobals.mdx b/docs/operations/getrankingsdailyglobals.mdx index 4bc1a2bf9..954123ff1 100644 --- a/docs/operations/getrankingsdailyglobals.mdx +++ b/docs/operations/getrankingsdailyglobals.mdx @@ -6,6 +6,6 @@ title: "GetRankingsDailyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getrankingsdailyrequest.mdx b/docs/operations/getrankingsdailyrequest.mdx index 04784a9f4..1c8a59473 100644 --- a/docs/operations/getrankingsdailyrequest.mdx +++ b/docs/operations/getrankingsdailyrequest.mdx @@ -6,13 +6,13 @@ title: "GetRankingsDailyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `start_date` | *Optional[str]* | :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 | -| `end_date` | *Optional[str]* | :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` | [Optional[operations.Period]](../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` | [Optional[operations.Modality]](../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 | -| `context_bucket` | [Optional[operations.ContextBucket]](../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` | [Optional[operations.GetRankingsDailyCategory]](../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 | -| `language_type` | [Optional[operations.LanguageType]](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `start_date` | *Optional[str]* | ➖ | 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 | +| `end_date` | *Optional[str]* | ➖ | 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` | [Optional[operations.Period]](../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` | [Optional[operations.Modality]](../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 | +| `context_bucket` | [Optional[operations.ContextBucket]](../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` | [Optional[operations.GetRankingsDailyCategory]](../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 | +| `language_type` | [Optional[operations.LanguageType]](../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/operations/getscimgroupmappingglobals.mdx b/docs/operations/getscimgroupmappingglobals.mdx index 6d93a7f25..9c87bcd2e 100644 --- a/docs/operations/getscimgroupmappingglobals.mdx +++ b/docs/operations/getscimgroupmappingglobals.mdx @@ -6,6 +6,6 @@ title: "GetScimGroupMappingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getscimgroupmappingrequest.mdx b/docs/operations/getscimgroupmappingrequest.mdx index 65e59b601..f10663e49 100644 --- a/docs/operations/getscimgroupmappingrequest.mdx +++ b/docs/operations/getscimgroupmappingrequest.mdx @@ -6,7 +6,7 @@ title: "GetScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `id` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/getscimsyncjobglobals.mdx b/docs/operations/getscimsyncjobglobals.mdx index 43e7a43da..1b8957588 100644 --- a/docs/operations/getscimsyncjobglobals.mdx +++ b/docs/operations/getscimsyncjobglobals.mdx @@ -6,6 +6,6 @@ title: "GetScimSyncJobGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getscimsyncjobrequest.mdx b/docs/operations/getscimsyncjobrequest.mdx index 6cf043dac..8ec38144b 100644 --- a/docs/operations/getscimsyncjobrequest.mdx +++ b/docs/operations/getscimsyncjobrequest.mdx @@ -6,7 +6,7 @@ title: "GetScimSyncJobRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `id` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/getsessioncostglobals.mdx b/docs/operations/getsessioncostglobals.mdx index 8ec32402d..6153e44e5 100644 --- a/docs/operations/getsessioncostglobals.mdx +++ b/docs/operations/getsessioncostglobals.mdx @@ -6,6 +6,6 @@ title: "GetSessionCostGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getsessioncostrequest.mdx b/docs/operations/getsessioncostrequest.mdx index 41b333db8..d7f6352ba 100644 --- a/docs/operations/getsessioncostrequest.mdx +++ b/docs/operations/getsessioncostrequest.mdx @@ -6,11 +6,11 @@ title: "GetSessionCostRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `app_slug` | *Optional[str]* | :heavy_minus_sign: | Filter to one published harness slug. | hermes-agent | -| `model` | *Optional[str]* | :heavy_minus_sign: | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | -| `turn_range` | [Optional[operations.TurnRange]](../operations/turnrange.mdx) | :heavy_minus_sign: | Filter by the inclusive number of turns in a session. | 10-49-turns | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of cells to return (1-500). Defaults to 100. | 100 | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `app_slug` | *Optional[str]* | ➖ | Filter to one published harness slug. | hermes-agent | +| `model` | *Optional[str]* | ➖ | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | +| `turn_range` | [Optional[operations.TurnRange]](../operations/turnrange.mdx) | ➖ | Filter by the inclusive number of turns in a session. | 10-49-turns | +| `limit` | *Optional[int]* | ➖ | Maximum number of cells to return (1-500). Defaults to 100. | 100 | +| `offset` | *OptionalNullable[int]* | ➖ | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/operations/getsessioncostresponse.mdx b/docs/operations/getsessioncostresponse.mdx index d79786dc8..c3d9e97c1 100644 --- a/docs/operations/getsessioncostresponse.mdx +++ b/docs/operations/getsessioncostresponse.mdx @@ -6,4 +6,4 @@ title: "GetSessionCostResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `result` | [components.SessionCostResponse](../components/sessioncostresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `result` | [components.SessionCostResponse](../components/sessioncostresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/gettaskclassificationsglobals.mdx b/docs/operations/gettaskclassificationsglobals.mdx index 34e94c3bb..9753c9912 100644 --- a/docs/operations/gettaskclassificationsglobals.mdx +++ b/docs/operations/gettaskclassificationsglobals.mdx @@ -6,6 +6,6 @@ title: "GetTaskClassificationsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/gettaskclassificationsrequest.mdx b/docs/operations/gettaskclassificationsrequest.mdx index acb6b4834..a2c427446 100644 --- a/docs/operations/gettaskclassificationsrequest.mdx +++ b/docs/operations/gettaskclassificationsrequest.mdx @@ -6,7 +6,7 @@ title: "GetTaskClassificationsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `window` | [Optional[operations.Window]](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `window` | [Optional[operations.Window]](../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/operations/gettoolglobals.mdx b/docs/operations/gettoolglobals.mdx index 2babeb71b..aa3278d9e 100644 --- a/docs/operations/gettoolglobals.mdx +++ b/docs/operations/gettoolglobals.mdx @@ -6,6 +6,6 @@ title: "GetToolGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/gettoolrequest.mdx b/docs/operations/gettoolrequest.mdx index 0d357688a..7d17a78e1 100644 --- a/docs/operations/gettoolrequest.mdx +++ b/docs/operations/gettoolrequest.mdx @@ -6,7 +6,7 @@ title: "GetToolRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `name` | *str* | :heavy_check_mark: | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `name` | *str* | ✅ | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | \ No newline at end of file diff --git a/docs/operations/gettoolresponse.mdx b/docs/operations/gettoolresponse.mdx index ebca60fe7..090b2b7ff 100644 --- a/docs/operations/gettoolresponse.mdx +++ b/docs/operations/gettoolresponse.mdx @@ -6,5 +6,5 @@ title: "GetToolResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | -| `result` | [Optional[components.GetToolResponse]](../components/gettoolresponse.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `headers` | Dict[str, List[*str*]] | ✅ | N/A | +| `result` | [Optional[components.GetToolResponse]](../components/gettoolresponse.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/operations/gettoolsecurity.mdx b/docs/operations/gettoolsecurity.mdx index 84b78828d..1bb9a8375 100644 --- a/docs/operations/gettoolsecurity.mdx +++ b/docs/operations/gettoolsecurity.mdx @@ -6,4 +6,4 @@ title: "GetToolSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bearer` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/getuseractivityglobals.mdx b/docs/operations/getuseractivityglobals.mdx index f31e13179..a92f5e3bb 100644 --- a/docs/operations/getuseractivityglobals.mdx +++ b/docs/operations/getuseractivityglobals.mdx @@ -6,6 +6,6 @@ title: "GetUserActivityGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getuseractivityrequest.mdx b/docs/operations/getuseractivityrequest.mdx index 421ac1a9f..21c7a35f5 100644 --- a/docs/operations/getuseractivityrequest.mdx +++ b/docs/operations/getuseractivityrequest.mdx @@ -6,11 +6,11 @@ title: "GetUserActivityRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `date_` | *Optional[str]* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `api_key_hash` | *Optional[str]* | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `user_id` | *Optional[str]* | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | -| `group_by` | [Optional[operations.GroupBy]](../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 | -| `workspace_id` | *Optional[str]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `date_` | *Optional[str]* | ➖ | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | +| `api_key_hash` | *Optional[str]* | ➖ | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | +| `user_id` | *Optional[str]* | ➖ | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | +| `group_by` | [Optional[operations.GroupBy]](../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 | +| `workspace_id` | *Optional[str]* | ➖ | 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/operations/getvideosglobals.mdx b/docs/operations/getvideosglobals.mdx index 7dfb46281..3b525becf 100644 --- a/docs/operations/getvideosglobals.mdx +++ b/docs/operations/getvideosglobals.mdx @@ -6,6 +6,6 @@ title: "GetVideosGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getvideosrequest.mdx b/docs/operations/getvideosrequest.mdx index 1b1c08753..8c7dcd651 100644 --- a/docs/operations/getvideosrequest.mdx +++ b/docs/operations/getvideosrequest.mdx @@ -6,7 +6,7 @@ title: "GetVideosRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `job_id` | *str* | ✅ | N/A | job-abc123 | \ No newline at end of file diff --git a/docs/operations/getworkspacebudgetglobals.mdx b/docs/operations/getworkspacebudgetglobals.mdx index 9aa76f556..e7fe36c8d 100644 --- a/docs/operations/getworkspacebudgetglobals.mdx +++ b/docs/operations/getworkspacebudgetglobals.mdx @@ -6,6 +6,6 @@ title: "GetWorkspaceBudgetGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getworkspacebudgetrequest.mdx b/docs/operations/getworkspacebudgetrequest.mdx index 953412ee4..483d59655 100644 --- a/docs/operations/getworkspacebudgetrequest.mdx +++ b/docs/operations/getworkspacebudgetrequest.mdx @@ -6,8 +6,8 @@ title: "GetWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../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/operations/getworkspaceglobals.mdx b/docs/operations/getworkspaceglobals.mdx index b3d863a26..c1cbeb71a 100644 --- a/docs/operations/getworkspaceglobals.mdx +++ b/docs/operations/getworkspaceglobals.mdx @@ -6,6 +6,6 @@ title: "GetWorkspaceGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/getworkspacerequest.mdx b/docs/operations/getworkspacerequest.mdx index b9ee3b720..1c1991af5 100644 --- a/docs/operations/getworkspacerequest.mdx +++ b/docs/operations/getworkspacerequest.mdx @@ -6,7 +6,7 @@ title: "GetWorkspaceRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/operations/granularity.mdx b/docs/operations/granularity.mdx index 8aa00fc17..9f3659151 100644 --- a/docs/operations/granularity.mdx +++ b/docs/operations/granularity.mdx @@ -6,5 +6,5 @@ title: "Granularity" | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `display_label` | *str* | :heavy_check_mark: | Human-readable label | Day | -| `name` | [operations.GranularityName](../operations/granularityname.mdx) | :heavy_check_mark: | Granularity identifier | day | \ No newline at end of file +| `display_label` | *str* | ✅ | Human-readable label | Day | +| `name` | [operations.GranularityName](../operations/granularityname.mdx) | ✅ | Granularity identifier | day | \ No newline at end of file diff --git a/docs/operations/imageurl.mdx b/docs/operations/imageurl.mdx index 693064d97..1f6cc546a 100644 --- a/docs/operations/imageurl.mdx +++ b/docs/operations/imageurl.mdx @@ -6,4 +6,4 @@ title: "ImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/input.mdx b/docs/operations/input.mdx index deecee214..5230c6b5a 100644 --- a/docs/operations/input.mdx +++ b/docs/operations/input.mdx @@ -6,4 +6,4 @@ title: "Input" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `content` | List[[operations.Content](../operations/content.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | List[[operations.Content](../operations/content.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/invokeinternglobals.mdx b/docs/operations/invokeinternglobals.mdx index fc2a01268..473ed152a 100644 --- a/docs/operations/invokeinternglobals.mdx +++ b/docs/operations/invokeinternglobals.mdx @@ -6,6 +6,6 @@ title: "InvokeInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/invokeinternrequest.mdx b/docs/operations/invokeinternrequest.mdx index 999ed9735..84ec62f00 100644 --- a/docs/operations/invokeinternrequest.mdx +++ b/docs/operations/invokeinternrequest.mdx @@ -6,8 +6,8 @@ title: "InvokeInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | The intern to run. | a11e0000-0000-4000-8000-000000000005 | -| `intern_invoke_request` | [components.InternInvokeRequest](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | The intern to run. | a11e0000-0000-4000-8000-000000000005 | +| `intern_invoke_request` | [components.InternInvokeRequest](../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/operations/invokeinternresponse.mdx b/docs/operations/invokeinternresponse.mdx index bf7427ee3..23145f5ef 100644 --- a/docs/operations/invokeinternresponse.mdx +++ b/docs/operations/invokeinternresponse.mdx @@ -6,5 +6,5 @@ title: "InvokeInternResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | | -| `result` | [components.InternInvokeAcceptedResponse](../components/interninvokeacceptedresponse.mdx) | :heavy_check_mark: | N/A | \{
"session_id": "b51a0e21-368b-4780-a220-14655bf28c55",
"status": "started"
} | \ No newline at end of file +| `headers` | Dict[str, List[*str*]] | ✅ | N/A | | +| `result` | [components.InternInvokeAcceptedResponse](../components/interninvokeacceptedresponse.mdx) | ✅ | N/A | \{
"session_id": "b51a0e21-368b-4780-a220-14655bf28c55",
"status": "started"
} | \ No newline at end of file diff --git a/docs/operations/listbatchesglobals.mdx b/docs/operations/listbatchesglobals.mdx index 62c0e67f6..681a0d319 100644 --- a/docs/operations/listbatchesglobals.mdx +++ b/docs/operations/listbatchesglobals.mdx @@ -6,6 +6,6 @@ title: "ListBatchesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listbatchesrequest.mdx b/docs/operations/listbatchesrequest.mdx index fd00d5a79..e6fd9d3f3 100644 --- a/docs/operations/listbatchesrequest.mdx +++ b/docs/operations/listbatchesrequest.mdx @@ -6,11 +6,11 @@ title: "ListBatchesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of batches to return, from 1 through 100. | 20 | -| `after` | *Optional[str]* | :heavy_minus_sign: | Batch id from the previous page's `last_id`. | batch_7a4b02 | -| `status` | List[[components.BatchListStatus](../components/batchliststatus.mdx)] | :heavy_minus_sign: | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | -| `created_after` | [Optional[components.BatchListTimestamp]](../components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | -| `created_before` | [Optional[components.BatchListTimestamp]](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Maximum number of batches to return, from 1 through 100. | 20 | +| `after` | *Optional[str]* | ➖ | Batch id from the previous page's `last_id`. | batch_7a4b02 | +| `status` | List[[components.BatchListStatus](../components/batchliststatus.mdx)] | ➖ | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | +| `created_after` | [Optional[components.BatchListTimestamp]](../components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | +| `created_before` | [Optional[components.BatchListTimestamp]](../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/operations/listbatchesresponse.mdx b/docs/operations/listbatchesresponse.mdx index 9a218bcdf..b6a1e09fe 100644 --- a/docs/operations/listbatchesresponse.mdx +++ b/docs/operations/listbatchesresponse.mdx @@ -6,4 +6,4 @@ title: "ListBatchesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `result` | [components.BatchListResponse](../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](../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/operations/listbyokkeysglobals.mdx b/docs/operations/listbyokkeysglobals.mdx index 67a37d54c..9ff457764 100644 --- a/docs/operations/listbyokkeysglobals.mdx +++ b/docs/operations/listbyokkeysglobals.mdx @@ -6,6 +6,6 @@ title: "ListBYOKKeysGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listbyokkeysrequest.mdx b/docs/operations/listbyokkeysrequest.mdx index f55e2c02b..44bfefb74 100644 --- a/docs/operations/listbyokkeysrequest.mdx +++ b/docs/operations/listbyokkeysrequest.mdx @@ -6,10 +6,10 @@ title: "ListBYOKKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :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` | [Optional[operations.Provider]](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | ➖ | 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` | [Optional[operations.Provider]](../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/operations/listbyokkeysresponse.mdx b/docs/operations/listbyokkeysresponse.mdx index e1615dcba..8e33decfd 100644 --- a/docs/operations/listbyokkeysresponse.mdx +++ b/docs/operations/listbyokkeysresponse.mdx @@ -6,4 +6,4 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [components.ListBYOKKeysResponse](../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](../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/operations/listcontainerfilesglobals.mdx b/docs/operations/listcontainerfilesglobals.mdx index 3bd312de0..eca6ca636 100644 --- a/docs/operations/listcontainerfilesglobals.mdx +++ b/docs/operations/listcontainerfilesglobals.mdx @@ -6,6 +6,6 @@ title: "ListContainerFilesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listcontainerfilesrequest.mdx b/docs/operations/listcontainerfilesrequest.mdx index 90add74a5..dbcde136c 100644 --- a/docs/operations/listcontainerfilesrequest.mdx +++ b/docs/operations/listcontainerfilesrequest.mdx @@ -6,9 +6,9 @@ title: "ListContainerFilesRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `container_id` | *str* | :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` | *Optional[int]* | :heavy_minus_sign: | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | -| `after` | *Optional[str]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `container_id` | *str* | ✅ | 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` | *Optional[int]* | ➖ | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | +| `after` | *Optional[str]* | ➖ | 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/operations/listdata.mdx b/docs/operations/listdata.mdx index a68b8ca9b..7de2f4b11 100644 --- a/docs/operations/listdata.mdx +++ b/docs/operations/listdata.mdx @@ -6,26 +6,26 @@ title: "ListData" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | :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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `external_user` | *Nullable[str]* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creator_user_id` | *Nullable[str]* | ✅ | 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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `external_user` | *Nullable[str]* | ✅ | Partner's end-user identifier used for attribution. | null | +| `hash` | *str* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `label` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | +| `name` | *str* | ✅ | Name of the API key | My Production Key | +| `updated_at` | *Nullable[str]* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *str* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/operations/listembeddingsmodelsglobals.mdx b/docs/operations/listembeddingsmodelsglobals.mdx index fad77722b..0e12ec2e1 100644 --- a/docs/operations/listembeddingsmodelsglobals.mdx +++ b/docs/operations/listembeddingsmodelsglobals.mdx @@ -6,6 +6,6 @@ title: "ListEmbeddingsModelsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listembeddingsmodelsrequest.mdx b/docs/operations/listembeddingsmodelsrequest.mdx index ad3e91f1e..dd273ae5c 100644 --- a/docs/operations/listembeddingsmodelsrequest.mdx +++ b/docs/operations/listembeddingsmodelsrequest.mdx @@ -6,8 +6,8 @@ title: "ListEmbeddingsModelsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | ➖ | 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/operations/listembeddingsmodelsresponse.mdx b/docs/operations/listembeddingsmodelsresponse.mdx index 053af0a81..207a7c495 100644 --- a/docs/operations/listembeddingsmodelsresponse.mdx +++ b/docs/operations/listembeddingsmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "ListEmbeddingsModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ModelsListResponse](../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](../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/operations/listendpointsglobals.mdx b/docs/operations/listendpointsglobals.mdx index 3e37c978a..d77c2f513 100644 --- a/docs/operations/listendpointsglobals.mdx +++ b/docs/operations/listendpointsglobals.mdx @@ -6,6 +6,6 @@ title: "ListEndpointsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listendpointsrequest.mdx b/docs/operations/listendpointsrequest.mdx index ae60c3675..3fa36648c 100644 --- a/docs/operations/listendpointsrequest.mdx +++ b/docs/operations/listendpointsrequest.mdx @@ -6,8 +6,8 @@ title: "ListEndpointsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | *str* | :heavy_check_mark: | The model slug | gpt-4 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `author` | *str* | ✅ | The author/organization of the model | openai | +| `slug` | *str* | ✅ | The model slug | gpt-4 | \ No newline at end of file diff --git a/docs/operations/listendpointsresponse.mdx b/docs/operations/listendpointsresponse.mdx index f5f6478ea..edebc0fe6 100644 --- a/docs/operations/listendpointsresponse.mdx +++ b/docs/operations/listendpointsresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.ListEndpointsResponse](../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](../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/operations/listendpointszdrglobals.mdx b/docs/operations/listendpointszdrglobals.mdx index 8f47131ce..794d7ca0d 100644 --- a/docs/operations/listendpointszdrglobals.mdx +++ b/docs/operations/listendpointszdrglobals.mdx @@ -6,6 +6,6 @@ title: "ListEndpointsZdrGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listendpointszdrrequest.mdx b/docs/operations/listendpointszdrrequest.mdx index 70f27d808..6f5e7d90f 100644 --- a/docs/operations/listendpointszdrrequest.mdx +++ b/docs/operations/listendpointszdrrequest.mdx @@ -6,6 +6,6 @@ title: "ListEndpointsZdrRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listendpointszdrresponse.mdx b/docs/operations/listendpointszdrresponse.mdx index 31012e2cf..79b2f2af3 100644 --- a/docs/operations/listendpointszdrresponse.mdx +++ b/docs/operations/listendpointszdrresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `data` | List[[components.PublicEndpoint](../components/publicendpoint.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[components.PublicEndpoint](../components/publicendpoint.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/listendusersglobals.mdx b/docs/operations/listendusersglobals.mdx index 3b3fecc1e..e4ece3f6e 100644 --- a/docs/operations/listendusersglobals.mdx +++ b/docs/operations/listendusersglobals.mdx @@ -6,6 +6,6 @@ title: "ListEndUsersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listendusersrequest.mdx b/docs/operations/listendusersrequest.mdx index a115cdba4..838bc726f 100644 --- a/docs/operations/listendusersrequest.mdx +++ b/docs/operations/listendusersrequest.mdx @@ -6,10 +6,10 @@ title: "ListEndUsersRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `user` | *Optional[str]* | :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 | -| `include_inactive` | *Optional[bool]* | :heavy_minus_sign: | Include deactivated registrations. | false | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `user` | *Optional[str]* | ➖ | 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 | +| `include_inactive` | *Optional[bool]* | ➖ | Include deactivated registrations. | false | \ No newline at end of file diff --git a/docs/operations/listendusersresponse.mdx b/docs/operations/listendusersresponse.mdx index d8ac52622..e110c2df2 100644 --- a/docs/operations/listendusersresponse.mdx +++ b/docs/operations/listendusersresponse.mdx @@ -6,4 +6,4 @@ title: "ListEndUsersResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListEndUsersResponse](../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](../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/operations/listfilesglobals.mdx b/docs/operations/listfilesglobals.mdx index 5e86176bf..199c293db 100644 --- a/docs/operations/listfilesglobals.mdx +++ b/docs/operations/listfilesglobals.mdx @@ -6,6 +6,6 @@ title: "ListFilesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listfilesrequest.mdx b/docs/operations/listfilesrequest.mdx index df4338da0..bca3e7ac5 100644 --- a/docs/operations/listfilesrequest.mdx +++ b/docs/operations/listfilesrequest.mdx @@ -6,14 +6,14 @@ title: "ListFilesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of files to return (1–1000). | 100 | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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` | *Optional[str]* | :heavy_minus_sign: | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `after_id` | *Optional[str]* | :heavy_minus_sign: | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `before_id` | *Optional[str]* | :heavy_minus_sign: | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `order` | [Optional[operations.Order]](../operations/order.mdx) | :heavy_minus_sign: | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Maximum number of files to return (1–1000). | 100 | +| `cursor` | *Optional[str]* | ➖ | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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` | *Optional[str]* | ➖ | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `after_id` | *Optional[str]* | ➖ | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `before_id` | *Optional[str]* | ➖ | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `order` | [Optional[operations.Order]](../operations/order.mdx) | ➖ | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file diff --git a/docs/operations/listfilesresponse.mdx b/docs/operations/listfilesresponse.mdx index bc29d45a6..5522ebc07 100644 --- a/docs/operations/listfilesresponse.mdx +++ b/docs/operations/listfilesresponse.mdx @@ -6,4 +6,4 @@ title: "ListFilesResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `result` | [components.FileListResponse](../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](../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/operations/listgenerationcontentglobals.mdx b/docs/operations/listgenerationcontentglobals.mdx index 8096c174f..b3d82e6fc 100644 --- a/docs/operations/listgenerationcontentglobals.mdx +++ b/docs/operations/listgenerationcontentglobals.mdx @@ -6,6 +6,6 @@ title: "ListGenerationContentGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listgenerationcontentrequest.mdx b/docs/operations/listgenerationcontentrequest.mdx index d1caecbb5..89bbcf386 100644 --- a/docs/operations/listgenerationcontentrequest.mdx +++ b/docs/operations/listgenerationcontentrequest.mdx @@ -6,7 +6,7 @@ title: "ListGenerationContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/operations/listglobals.mdx b/docs/operations/listglobals.mdx index b13c7abde..6774b3ef5 100644 --- a/docs/operations/listglobals.mdx +++ b/docs/operations/listglobals.mdx @@ -6,6 +6,6 @@ title: "ListGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listguardrailkeyassignmentsglobals.mdx b/docs/operations/listguardrailkeyassignmentsglobals.mdx index 8b06bf79e..4f6598763 100644 --- a/docs/operations/listguardrailkeyassignmentsglobals.mdx +++ b/docs/operations/listguardrailkeyassignmentsglobals.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailKeyAssignmentsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listguardrailkeyassignmentsrequest.mdx b/docs/operations/listguardrailkeyassignmentsrequest.mdx index 0197e6a85..953169080 100644 --- a/docs/operations/listguardrailkeyassignmentsrequest.mdx +++ b/docs/operations/listguardrailkeyassignmentsrequest.mdx @@ -6,9 +6,9 @@ title: "ListGuardrailKeyAssignmentsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listguardrailkeyassignmentsresponse.mdx b/docs/operations/listguardrailkeyassignmentsresponse.mdx index 868475866..a1d8fb3fe 100644 --- a/docs/operations/listguardrailkeyassignmentsresponse.mdx +++ b/docs/operations/listguardrailkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListKeyAssignmentsResponse](../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](../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/operations/listguardrailmemberassignmentsglobals.mdx b/docs/operations/listguardrailmemberassignmentsglobals.mdx index 98c69e74c..ecb52ea72 100644 --- a/docs/operations/listguardrailmemberassignmentsglobals.mdx +++ b/docs/operations/listguardrailmemberassignmentsglobals.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailMemberAssignmentsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listguardrailmemberassignmentsrequest.mdx b/docs/operations/listguardrailmemberassignmentsrequest.mdx index c7d2bdab2..c41856dcc 100644 --- a/docs/operations/listguardrailmemberassignmentsrequest.mdx +++ b/docs/operations/listguardrailmemberassignmentsrequest.mdx @@ -6,9 +6,9 @@ title: "ListGuardrailMemberAssignmentsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listguardrailmemberassignmentsresponse.mdx b/docs/operations/listguardrailmemberassignmentsresponse.mdx index 3c19a6f18..14426922f 100644 --- a/docs/operations/listguardrailmemberassignmentsresponse.mdx +++ b/docs/operations/listguardrailmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListMemberAssignmentsResponse](../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](../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/operations/listguardrailsglobals.mdx b/docs/operations/listguardrailsglobals.mdx index 60d11dfac..48b141f20 100644 --- a/docs/operations/listguardrailsglobals.mdx +++ b/docs/operations/listguardrailsglobals.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listguardrailsrequest.mdx b/docs/operations/listguardrailsrequest.mdx index 465dde596..c84b9a13d 100644 --- a/docs/operations/listguardrailsrequest.mdx +++ b/docs/operations/listguardrailsrequest.mdx @@ -6,9 +6,9 @@ title: "ListGuardrailsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | ➖ | 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/operations/listguardrailsresponse.mdx b/docs/operations/listguardrailsresponse.mdx index e3b731505..7ac925b1d 100644 --- a/docs/operations/listguardrailsresponse.mdx +++ b/docs/operations/listguardrailsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListGuardrailsResponse](../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](../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/operations/listimagemodelendpointsglobals.mdx b/docs/operations/listimagemodelendpointsglobals.mdx index ffac4de97..2aadf9a73 100644 --- a/docs/operations/listimagemodelendpointsglobals.mdx +++ b/docs/operations/listimagemodelendpointsglobals.mdx @@ -6,6 +6,6 @@ title: "ListImageModelEndpointsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listimagemodelendpointsrequest.mdx b/docs/operations/listimagemodelendpointsrequest.mdx index 871687a00..9fe96e1a5 100644 --- a/docs/operations/listimagemodelendpointsrequest.mdx +++ b/docs/operations/listimagemodelendpointsrequest.mdx @@ -6,8 +6,8 @@ title: "ListImageModelEndpointsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *str* | :heavy_check_mark: | Model author/organization | bytedance-seed | -| `slug` | *str* | :heavy_check_mark: | Model slug | seedream-4.5 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `author` | *str* | ✅ | Model author/organization | bytedance-seed | +| `slug` | *str* | ✅ | Model slug | seedream-4.5 | \ No newline at end of file diff --git a/docs/operations/listimagemodelsglobals.mdx b/docs/operations/listimagemodelsglobals.mdx index e3ad1251b..5a2958a49 100644 --- a/docs/operations/listimagemodelsglobals.mdx +++ b/docs/operations/listimagemodelsglobals.mdx @@ -6,6 +6,6 @@ title: "ListImageModelsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listimagemodelsrequest.mdx b/docs/operations/listimagemodelsrequest.mdx index 590e46d83..1c45ba409 100644 --- a/docs/operations/listimagemodelsrequest.mdx +++ b/docs/operations/listimagemodelsrequest.mdx @@ -6,6 +6,6 @@ title: "ListImageModelsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listinterneffectivevaultsecretsglobals.mdx b/docs/operations/listinterneffectivevaultsecretsglobals.mdx index bd5c8c464..de0a0db8e 100644 --- a/docs/operations/listinterneffectivevaultsecretsglobals.mdx +++ b/docs/operations/listinterneffectivevaultsecretsglobals.mdx @@ -6,6 +6,6 @@ title: "ListInternEffectiveVaultSecretsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listinterneffectivevaultsecretsrequest.mdx b/docs/operations/listinterneffectivevaultsecretsrequest.mdx index ca1e31d1c..900dcf3e2 100644 --- a/docs/operations/listinterneffectivevaultsecretsrequest.mdx +++ b/docs/operations/listinterneffectivevaultsecretsrequest.mdx @@ -6,9 +6,9 @@ title: "ListInternEffectiveVaultSecretsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/operations/listinternsglobals.mdx b/docs/operations/listinternsglobals.mdx index 3a55ed59f..94241de64 100644 --- a/docs/operations/listinternsglobals.mdx +++ b/docs/operations/listinternsglobals.mdx @@ -6,6 +6,6 @@ title: "ListInternsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listinternsrequest.mdx b/docs/operations/listinternsrequest.mdx index c595b861d..30f908550 100644 --- a/docs/operations/listinternsrequest.mdx +++ b/docs/operations/listinternsrequest.mdx @@ -6,10 +6,10 @@ title: "ListInternsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of interns to return, from 1 through 500. | 50 | -| `status` | List[[operations.Status](../operations/status.mdx)] | :heavy_minus_sign: | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | -| `starting_after` | *Optional[str]* | :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 | -| `workspace_id` | *Optional[str]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Maximum number of interns to return, from 1 through 500. | 50 | +| `status` | List[[operations.Status](../operations/status.mdx)] | ➖ | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | +| `starting_after` | *Optional[str]* | ➖ | 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 | +| `workspace_id` | *Optional[str]* | ➖ | 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/operations/listinternvaultsecretsglobals.mdx b/docs/operations/listinternvaultsecretsglobals.mdx index 032e98ae1..97687a0b3 100644 --- a/docs/operations/listinternvaultsecretsglobals.mdx +++ b/docs/operations/listinternvaultsecretsglobals.mdx @@ -6,6 +6,6 @@ title: "ListInternVaultSecretsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listinternvaultsecretsrequest.mdx b/docs/operations/listinternvaultsecretsrequest.mdx index feadc7485..59190cfb2 100644 --- a/docs/operations/listinternvaultsecretsrequest.mdx +++ b/docs/operations/listinternvaultsecretsrequest.mdx @@ -6,9 +6,9 @@ title: "ListInternVaultSecretsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/operations/listkeyassignmentsglobals.mdx b/docs/operations/listkeyassignmentsglobals.mdx index a93efaec3..e497a4ed0 100644 --- a/docs/operations/listkeyassignmentsglobals.mdx +++ b/docs/operations/listkeyassignmentsglobals.mdx @@ -6,6 +6,6 @@ title: "ListKeyAssignmentsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listkeyassignmentsrequest.mdx b/docs/operations/listkeyassignmentsrequest.mdx index 9ca686875..31080be44 100644 --- a/docs/operations/listkeyassignmentsrequest.mdx +++ b/docs/operations/listkeyassignmentsrequest.mdx @@ -6,8 +6,8 @@ title: "ListKeyAssignmentsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listkeyassignmentsresponse.mdx b/docs/operations/listkeyassignmentsresponse.mdx index b26f687df..05e61ef7e 100644 --- a/docs/operations/listkeyassignmentsresponse.mdx +++ b/docs/operations/listkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListKeyAssignmentsResponse](../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](../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/operations/listmemberassignmentsglobals.mdx b/docs/operations/listmemberassignmentsglobals.mdx index e5d123af9..93d863c44 100644 --- a/docs/operations/listmemberassignmentsglobals.mdx +++ b/docs/operations/listmemberassignmentsglobals.mdx @@ -6,6 +6,6 @@ title: "ListMemberAssignmentsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listmemberassignmentsrequest.mdx b/docs/operations/listmemberassignmentsrequest.mdx index 7215640ea..e0c6b6afb 100644 --- a/docs/operations/listmemberassignmentsrequest.mdx +++ b/docs/operations/listmemberassignmentsrequest.mdx @@ -6,8 +6,8 @@ title: "ListMemberAssignmentsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listmemberassignmentsresponse.mdx b/docs/operations/listmemberassignmentsresponse.mdx index 0206ec09d..92cc8f0c9 100644 --- a/docs/operations/listmemberassignmentsresponse.mdx +++ b/docs/operations/listmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListMemberAssignmentsResponse](../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](../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/operations/listmodelscountglobals.mdx b/docs/operations/listmodelscountglobals.mdx index 0daab751f..c33a388a2 100644 --- a/docs/operations/listmodelscountglobals.mdx +++ b/docs/operations/listmodelscountglobals.mdx @@ -6,6 +6,6 @@ title: "ListModelsCountGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listmodelscountrequest.mdx b/docs/operations/listmodelscountrequest.mdx index 163aa28dd..7e3909022 100644 --- a/docs/operations/listmodelscountrequest.mdx +++ b/docs/operations/listmodelscountrequest.mdx @@ -6,7 +6,7 @@ title: "ListModelsCountRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `output_modalities` | *Optional[str]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `output_modalities` | *Optional[str]* | ➖ | 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/operations/listmodelsuserglobals.mdx b/docs/operations/listmodelsuserglobals.mdx index f0a800135..b6ff4ac61 100644 --- a/docs/operations/listmodelsuserglobals.mdx +++ b/docs/operations/listmodelsuserglobals.mdx @@ -6,6 +6,6 @@ title: "ListModelsUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listmodelsuserrequest.mdx b/docs/operations/listmodelsuserrequest.mdx index 0ad201f8a..61a97beb1 100644 --- a/docs/operations/listmodelsuserrequest.mdx +++ b/docs/operations/listmodelsuserrequest.mdx @@ -6,9 +6,9 @@ title: "ListModelsUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `output_modalities` | *Optional[str]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `output_modalities` | *Optional[str]* | ➖ | 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/operations/listmodelsuserresponse.mdx b/docs/operations/listmodelsuserresponse.mdx index 380f686c1..0ed4eca01 100644 --- a/docs/operations/listmodelsuserresponse.mdx +++ b/docs/operations/listmodelsuserresponse.mdx @@ -6,4 +6,4 @@ title: "ListModelsUserResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ModelsListResponse](../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](../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/operations/listmodelsusersecurity.mdx b/docs/operations/listmodelsusersecurity.mdx index c7dbff35b..b5f5a5361 100644 --- a/docs/operations/listmodelsusersecurity.mdx +++ b/docs/operations/listmodelsusersecurity.mdx @@ -6,4 +6,4 @@ title: "ListModelsUserSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bearer` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/listoauthjwksglobals.mdx b/docs/operations/listoauthjwksglobals.mdx index 17a2b2df2..d55e03c85 100644 --- a/docs/operations/listoauthjwksglobals.mdx +++ b/docs/operations/listoauthjwksglobals.mdx @@ -6,6 +6,6 @@ title: "ListOauthJwksGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listoauthjwksrequest.mdx b/docs/operations/listoauthjwksrequest.mdx index b0535221a..aa79b539f 100644 --- a/docs/operations/listoauthjwksrequest.mdx +++ b/docs/operations/listoauthjwksrequest.mdx @@ -6,6 +6,6 @@ title: "ListOauthJwksRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listobservabilitydestinationsglobals.mdx b/docs/operations/listobservabilitydestinationsglobals.mdx index 40271fec1..17f003ef8 100644 --- a/docs/operations/listobservabilitydestinationsglobals.mdx +++ b/docs/operations/listobservabilitydestinationsglobals.mdx @@ -6,6 +6,6 @@ title: "ListObservabilityDestinationsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listobservabilitydestinationsrequest.mdx b/docs/operations/listobservabilitydestinationsrequest.mdx index 939ce50af..c1922a71e 100644 --- a/docs/operations/listobservabilitydestinationsrequest.mdx +++ b/docs/operations/listobservabilitydestinationsrequest.mdx @@ -6,9 +6,9 @@ title: "ListObservabilityDestinationsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | ➖ | 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/operations/listobservabilitydestinationsresponse.mdx b/docs/operations/listobservabilitydestinationsresponse.mdx index 2c5e760b9..a0631b095 100644 --- a/docs/operations/listobservabilitydestinationsresponse.mdx +++ b/docs/operations/listobservabilitydestinationsresponse.mdx @@ -6,4 +6,4 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListObservabilityDestinationsResponse](../components/listobservabilitydestinationsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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](../components/listobservabilitydestinationsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_cost_allocation": 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/operations/listorganizationmembersdata.mdx b/docs/operations/listorganizationmembersdata.mdx index 2469c6aef..5879c38a6 100644 --- a/docs/operations/listorganizationmembersdata.mdx +++ b/docs/operations/listorganizationmembersdata.mdx @@ -6,8 +6,8 @@ title: "ListOrganizationMembersData" | Field | Type | Required | Description | Example | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `email` | *str* | :heavy_check_mark: | Email address of the member | jane.doe@example.com | -| `first_name` | *Nullable[str]* | :heavy_check_mark: | First name of the member | Jane | -| `id` | *str* | :heavy_check_mark: | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | -| `last_name` | *Nullable[str]* | :heavy_check_mark: | Last name of the member | Doe | -| `role` | [operations.Role](../operations/role.mdx) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file +| `email` | *str* | ✅ | Email address of the member | jane.doe@example.com | +| `first_name` | *Nullable[str]* | ✅ | First name of the member | Jane | +| `id` | *str* | ✅ | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | +| `last_name` | *Nullable[str]* | ✅ | Last name of the member | Doe | +| `role` | [operations.Role](../operations/role.mdx) | ✅ | Role of the member in the organization | org:member | \ No newline at end of file diff --git a/docs/operations/listorganizationmembersglobals.mdx b/docs/operations/listorganizationmembersglobals.mdx index de31dc7f5..5a74849d8 100644 --- a/docs/operations/listorganizationmembersglobals.mdx +++ b/docs/operations/listorganizationmembersglobals.mdx @@ -6,6 +6,6 @@ title: "ListOrganizationMembersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listorganizationmembersrequest.mdx b/docs/operations/listorganizationmembersrequest.mdx index b9c2c5a33..6e57d5edc 100644 --- a/docs/operations/listorganizationmembersrequest.mdx +++ b/docs/operations/listorganizationmembersrequest.mdx @@ -6,8 +6,8 @@ title: "ListOrganizationMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listorganizationmembersresponse.mdx b/docs/operations/listorganizationmembersresponse.mdx index 5de552097..73391339b 100644 --- a/docs/operations/listorganizationmembersresponse.mdx +++ b/docs/operations/listorganizationmembersresponse.mdx @@ -6,4 +6,4 @@ title: "ListOrganizationMembersResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `result` | [operations.ListOrganizationMembersResponseBody](../operations/listorganizationmembersresponsebody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `result` | [operations.ListOrganizationMembersResponseBody](../operations/listorganizationmembersresponsebody.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/listorganizationmembersresponsebody.mdx b/docs/operations/listorganizationmembersresponsebody.mdx index 56cd9c557..9b9946404 100644 --- a/docs/operations/listorganizationmembersresponsebody.mdx +++ b/docs/operations/listorganizationmembersresponsebody.mdx @@ -9,5 +9,5 @@ List of organization members | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `data` | List[[operations.ListOrganizationMembersData](../operations/listorganizationmembersdata.mdx)] | :heavy_check_mark: | List of organization members | | -| `total_count` | *int* | :heavy_check_mark: | Total number of members in the organization | 25 | \ No newline at end of file +| `data` | List[[operations.ListOrganizationMembersData](../operations/listorganizationmembersdata.mdx)] | ✅ | List of organization members | | +| `total_count` | *int* | ✅ | Total number of members in the organization | 25 | \ No newline at end of file diff --git a/docs/operations/listpresetsglobals.mdx b/docs/operations/listpresetsglobals.mdx index 73d98355a..a0d0bd85d 100644 --- a/docs/operations/listpresetsglobals.mdx +++ b/docs/operations/listpresetsglobals.mdx @@ -6,6 +6,6 @@ title: "ListPresetsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listpresetsrequest.mdx b/docs/operations/listpresetsrequest.mdx index d3f380a31..947e5e16a 100644 --- a/docs/operations/listpresetsrequest.mdx +++ b/docs/operations/listpresetsrequest.mdx @@ -6,8 +6,8 @@ title: "ListPresetsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listpresetsresponse.mdx b/docs/operations/listpresetsresponse.mdx index 0bd7386a5..afaac85ea 100644 --- a/docs/operations/listpresetsresponse.mdx +++ b/docs/operations/listpresetsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [components.ListPresetsResponse](../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](../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/operations/listpresetversionsglobals.mdx b/docs/operations/listpresetversionsglobals.mdx index f97938ef0..f043e963b 100644 --- a/docs/operations/listpresetversionsglobals.mdx +++ b/docs/operations/listpresetversionsglobals.mdx @@ -6,6 +6,6 @@ title: "ListPresetVersionsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listpresetversionsrequest.mdx b/docs/operations/listpresetversionsrequest.mdx index f33507722..2ffe5ebd5 100644 --- a/docs/operations/listpresetversionsrequest.mdx +++ b/docs/operations/listpresetversionsrequest.mdx @@ -6,9 +6,9 @@ title: "ListPresetVersionsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listpresetversionsresponse.mdx b/docs/operations/listpresetversionsresponse.mdx index 794d77eb2..e6f1f7d64 100644 --- a/docs/operations/listpresetversionsresponse.mdx +++ b/docs/operations/listpresetversionsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetVersionsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [components.ListPresetVersionsResponse](../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](../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/operations/listprivateendpointsglobals.mdx b/docs/operations/listprivateendpointsglobals.mdx index 6306718f7..6e53d08e6 100644 --- a/docs/operations/listprivateendpointsglobals.mdx +++ b/docs/operations/listprivateendpointsglobals.mdx @@ -6,6 +6,6 @@ title: "ListPrivateEndpointsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listprivateendpointsrequest.mdx b/docs/operations/listprivateendpointsrequest.mdx index bc225950e..cd5702265 100644 --- a/docs/operations/listprivateendpointsrequest.mdx +++ b/docs/operations/listprivateendpointsrequest.mdx @@ -6,6 +6,6 @@ title: "ListPrivateEndpointsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listprovidersdata.mdx b/docs/operations/listprovidersdata.mdx index 10580e98d..974c7918b 100644 --- a/docs/operations/listprovidersdata.mdx +++ b/docs/operations/listprovidersdata.mdx @@ -6,10 +6,10 @@ title: "ListProvidersData" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `datacenters` | List[[operations.Datacenter](../operations/datacenter.mdx)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `headquarters` | [OptionalNullable[operations.Headquarters]](../operations/headquarters.mdx) | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | -| `name` | *str* | :heavy_check_mark: | Display name of the provider | OpenAI | -| `privacy_policy_url` | *Nullable[str]* | :heavy_check_mark: | URL to the provider's privacy policy | https://openai.com/privacy | -| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the provider | openai | -| `status_page_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | -| `terms_of_service_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file +| `datacenters` | List[[operations.Datacenter](../operations/datacenter.mdx)] | ➖ | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | +| `headquarters` | [OptionalNullable[operations.Headquarters]](../operations/headquarters.mdx) | ➖ | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | +| `name` | *str* | ✅ | Display name of the provider | OpenAI | +| `privacy_policy_url` | *Nullable[str]* | ✅ | URL to the provider's privacy policy | https://openai.com/privacy | +| `slug` | *str* | ✅ | URL-friendly identifier for the provider | openai | +| `status_page_url` | *OptionalNullable[str]* | ➖ | URL to the provider's status page | https://status.openai.com | +| `terms_of_service_url` | *OptionalNullable[str]* | ➖ | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file diff --git a/docs/operations/listprovidersglobals.mdx b/docs/operations/listprovidersglobals.mdx index 2ad08ac05..c4826aba3 100644 --- a/docs/operations/listprovidersglobals.mdx +++ b/docs/operations/listprovidersglobals.mdx @@ -6,6 +6,6 @@ title: "ListProvidersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listprovidersrequest.mdx b/docs/operations/listprovidersrequest.mdx index 5514d8141..34686a50e 100644 --- a/docs/operations/listprovidersrequest.mdx +++ b/docs/operations/listprovidersrequest.mdx @@ -6,6 +6,6 @@ title: "ListProvidersRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listprovidersresponse.mdx b/docs/operations/listprovidersresponse.mdx index 81b20bf49..90ccff07b 100644 --- a/docs/operations/listprovidersresponse.mdx +++ b/docs/operations/listprovidersresponse.mdx @@ -9,4 +9,4 @@ Returns a list of providers | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | List[[operations.ListProvidersData](../operations/listprovidersdata.mdx)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | List[[operations.ListProvidersData](../operations/listprovidersdata.mdx)] | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/listrequest.mdx b/docs/operations/listrequest.mdx index 94a52d362..f8b721eb4 100644 --- a/docs/operations/listrequest.mdx +++ b/docs/operations/listrequest.mdx @@ -6,10 +6,10 @@ title: "ListRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `include_disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `include_expired` | *Optional[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[int]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | -| `workspace_id` | *Optional[str]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `include_disabled` | *Optional[bool]* | ➖ | Whether to include disabled API keys in the response | false | +| `include_expired` | *Optional[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[int]* | ➖ | Number of API keys to skip for pagination | 0 | +| `workspace_id` | *Optional[str]* | ➖ | 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/operations/listresponse.mdx b/docs/operations/listresponse.mdx index ffadcfc30..0f6002eca 100644 --- a/docs/operations/listresponse.mdx +++ b/docs/operations/listresponse.mdx @@ -9,4 +9,4 @@ List of API keys | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | List[[operations.ListData](../operations/listdata.mdx)] | :heavy_check_mark: | List of API keys | \ No newline at end of file +| `data` | List[[operations.ListData](../operations/listdata.mdx)] | ✅ | List of API keys | \ No newline at end of file diff --git a/docs/operations/listscimgroupmappingsglobals.mdx b/docs/operations/listscimgroupmappingsglobals.mdx index 579e2acea..ff722300c 100644 --- a/docs/operations/listscimgroupmappingsglobals.mdx +++ b/docs/operations/listscimgroupmappingsglobals.mdx @@ -6,6 +6,6 @@ title: "ListScimGroupMappingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listscimgroupmappingsrequest.mdx b/docs/operations/listscimgroupmappingsrequest.mdx index e30aea7a5..62346a667 100644 --- a/docs/operations/listscimgroupmappingsrequest.mdx +++ b/docs/operations/listscimgroupmappingsrequest.mdx @@ -6,8 +6,8 @@ title: "ListScimGroupMappingsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listscimgroupmappingsresponse.mdx b/docs/operations/listscimgroupmappingsresponse.mdx index f426e5f45..ababb58d5 100644 --- a/docs/operations/listscimgroupmappingsresponse.mdx +++ b/docs/operations/listscimgroupmappingsresponse.mdx @@ -6,4 +6,4 @@ title: "ListScimGroupMappingsResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `result` | [components.ListScimGroupMappingsResponse](../components/listscimgroupmappingsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `result` | [components.ListScimGroupMappingsResponse](../components/listscimgroupmappingsresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/listscimgroupsglobals.mdx b/docs/operations/listscimgroupsglobals.mdx index 5294ada2e..87e77c400 100644 --- a/docs/operations/listscimgroupsglobals.mdx +++ b/docs/operations/listscimgroupsglobals.mdx @@ -6,6 +6,6 @@ title: "ListScimGroupsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listscimgroupsrequest.mdx b/docs/operations/listscimgroupsrequest.mdx index d08e86e01..7c1dd4612 100644 --- a/docs/operations/listscimgroupsrequest.mdx +++ b/docs/operations/listscimgroupsrequest.mdx @@ -6,10 +6,10 @@ title: "ListScimGroupsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `display_name` | *Optional[str]* | :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 | -| `external_id` | *Optional[str]* | :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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `display_name` | *Optional[str]* | ➖ | 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 | +| `external_id` | *Optional[str]* | ➖ | 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/operations/listscimgroupsresponse.mdx b/docs/operations/listscimgroupsresponse.mdx index 80f9a41f5..ccebbd181 100644 --- a/docs/operations/listscimgroupsresponse.mdx +++ b/docs/operations/listscimgroupsresponse.mdx @@ -6,4 +6,4 @@ title: "ListScimGroupsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `result` | [components.ListScimGroupsResponse](../components/listscimgroupsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `result` | [components.ListScimGroupsResponse](../components/listscimgroupsresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/listtoolsglobals.mdx b/docs/operations/listtoolsglobals.mdx index 39d3d2c10..be81f3e6e 100644 --- a/docs/operations/listtoolsglobals.mdx +++ b/docs/operations/listtoolsglobals.mdx @@ -6,6 +6,6 @@ title: "ListToolsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listtoolsrequest.mdx b/docs/operations/listtoolsrequest.mdx index 4a996545d..7b36c4dfe 100644 --- a/docs/operations/listtoolsrequest.mdx +++ b/docs/operations/listtoolsrequest.mdx @@ -6,9 +6,9 @@ title: "ListToolsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | -| `api_format` | [Optional[operations.APIFormat]](../operations/apiformat.mdx) | :heavy_minus_sign: | Only tools usable on this API format | responses | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | +| `api_format` | [Optional[operations.APIFormat]](../operations/apiformat.mdx) | ➖ | Only tools usable on this API format | responses | \ No newline at end of file diff --git a/docs/operations/listtoolssecurity.mdx b/docs/operations/listtoolssecurity.mdx index 92fe7946e..95e8eb5db 100644 --- a/docs/operations/listtoolssecurity.mdx +++ b/docs/operations/listtoolssecurity.mdx @@ -6,4 +6,4 @@ title: "ListToolsSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bearer` | *str* | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/listvaultsecretsglobals.mdx b/docs/operations/listvaultsecretsglobals.mdx index 0d090bdea..cbe965813 100644 --- a/docs/operations/listvaultsecretsglobals.mdx +++ b/docs/operations/listvaultsecretsglobals.mdx @@ -6,6 +6,6 @@ title: "ListVaultSecretsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listvaultsecretsrequest.mdx b/docs/operations/listvaultsecretsrequest.mdx index 962a3e12c..18834a34d 100644 --- a/docs/operations/listvaultsecretsrequest.mdx +++ b/docs/operations/listvaultsecretsrequest.mdx @@ -6,8 +6,8 @@ title: "ListVaultSecretsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/operations/listvideoscontentglobals.mdx b/docs/operations/listvideoscontentglobals.mdx index 4a27d350e..a81b48e72 100644 --- a/docs/operations/listvideoscontentglobals.mdx +++ b/docs/operations/listvideoscontentglobals.mdx @@ -6,6 +6,6 @@ title: "ListVideosContentGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listvideoscontentrequest.mdx b/docs/operations/listvideoscontentrequest.mdx index 0ecef072f..e54fe6a6f 100644 --- a/docs/operations/listvideoscontentrequest.mdx +++ b/docs/operations/listvideoscontentrequest.mdx @@ -6,8 +6,8 @@ title: "ListVideosContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | -| `index` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 0 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `job_id` | *str* | ✅ | N/A | job-abc123 | +| `index` | *OptionalNullable[int]* | ➖ | N/A | 0 | \ No newline at end of file diff --git a/docs/operations/listvideosmodelsglobals.mdx b/docs/operations/listvideosmodelsglobals.mdx index a7fc9b7b2..8332329b5 100644 --- a/docs/operations/listvideosmodelsglobals.mdx +++ b/docs/operations/listvideosmodelsglobals.mdx @@ -6,6 +6,6 @@ title: "ListVideosModelsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listvideosmodelsrequest.mdx b/docs/operations/listvideosmodelsrequest.mdx index 5bd866fda..37eed3047 100644 --- a/docs/operations/listvideosmodelsrequest.mdx +++ b/docs/operations/listvideosmodelsrequest.mdx @@ -6,6 +6,6 @@ title: "ListVideosModelsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listworkspacebudgetsglobals.mdx b/docs/operations/listworkspacebudgetsglobals.mdx index 88549dbdc..6a68defee 100644 --- a/docs/operations/listworkspacebudgetsglobals.mdx +++ b/docs/operations/listworkspacebudgetsglobals.mdx @@ -6,6 +6,6 @@ title: "ListWorkspaceBudgetsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listworkspacebudgetsrequest.mdx b/docs/operations/listworkspacebudgetsrequest.mdx index d076d36ce..6a0912851 100644 --- a/docs/operations/listworkspacebudgetsrequest.mdx +++ b/docs/operations/listworkspacebudgetsrequest.mdx @@ -6,7 +6,7 @@ title: "ListWorkspaceBudgetsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/operations/listworkspacemembersglobals.mdx b/docs/operations/listworkspacemembersglobals.mdx index c8f845c55..68652790b 100644 --- a/docs/operations/listworkspacemembersglobals.mdx +++ b/docs/operations/listworkspacemembersglobals.mdx @@ -6,6 +6,6 @@ title: "ListWorkspaceMembersGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listworkspacemembersrequest.mdx b/docs/operations/listworkspacemembersrequest.mdx index 0c97c81ea..cff5df07f 100644 --- a/docs/operations/listworkspacemembersrequest.mdx +++ b/docs/operations/listworkspacemembersrequest.mdx @@ -6,9 +6,9 @@ title: "ListWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listworkspacemembersresponse.mdx b/docs/operations/listworkspacemembersresponse.mdx index 94558019b..f08af8246 100644 --- a/docs/operations/listworkspacemembersresponse.mdx +++ b/docs/operations/listworkspacemembersresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListWorkspaceMembersResponse](../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](../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/operations/listworkspacesglobals.mdx b/docs/operations/listworkspacesglobals.mdx index 2a6be98ca..8e6cf8715 100644 --- a/docs/operations/listworkspacesglobals.mdx +++ b/docs/operations/listworkspacesglobals.mdx @@ -6,6 +6,6 @@ title: "ListWorkspacesGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/listworkspacesrequest.mdx b/docs/operations/listworkspacesrequest.mdx index 0903d08e1..fdd280c97 100644 --- a/docs/operations/listworkspacesrequest.mdx +++ b/docs/operations/listworkspacesrequest.mdx @@ -6,8 +6,8 @@ title: "ListWorkspacesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/operations/listworkspacesresponse.mdx b/docs/operations/listworkspacesresponse.mdx index 44258f9aa..c51d303d2 100644 --- a/docs/operations/listworkspacesresponse.mdx +++ b/docs/operations/listworkspacesresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListWorkspacesResponse](../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](../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/operations/metadata.mdx b/docs/operations/metadata.mdx index 33c6b11a5..87a43d799 100644 --- a/docs/operations/metadata.mdx +++ b/docs/operations/metadata.mdx @@ -6,6 +6,6 @@ title: "Metadata" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `query_time_ms` | *float* | :heavy_check_mark: | N/A | -| `row_count` | *int* | :heavy_check_mark: | N/A | -| `truncated` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file +| `query_time_ms` | *float* | ✅ | N/A | +| `row_count` | *int* | ✅ | N/A | +| `truncated` | *bool* | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/metric.mdx b/docs/operations/metric.mdx index a1b3a3e10..d2520eaca 100644 --- a/docs/operations/metric.mdx +++ b/docs/operations/metric.mdx @@ -6,7 +6,7 @@ title: "Metric" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `display_format` | [operations.DisplayFormat](../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 | -| `display_label` | *str* | :heavy_check_mark: | Human-readable label | Request Count | -| `is_rate` | *bool* | :heavy_check_mark: | Whether this metric is a rate/ratio (averaged, not summed) | | -| `name` | *str* | :heavy_check_mark: | Metric identifier used in query requests | request_count | \ No newline at end of file +| `display_format` | [operations.DisplayFormat](../operations/displayformat.mdx) | ✅ | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | +| `display_label` | *str* | ✅ | Human-readable label | Request Count | +| `is_rate` | *bool* | ✅ | Whether this metric is a rate/ratio (averaged, not summed) | | +| `name` | *str* | ✅ | Metric identifier used in query requests | request_count | \ No newline at end of file diff --git a/docs/operations/operator.mdx b/docs/operations/operator.mdx index f14d7d1a7..9f83faabf 100644 --- a/docs/operations/operator.mdx +++ b/docs/operations/operator.mdx @@ -6,5 +6,5 @@ title: "Operator" | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `name` | [operations.OperatorName](../operations/operatorname.mdx) | :heavy_check_mark: | Operator identifier used in filter definitions | eq | -| `value_type` | [operations.ValueType](../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](../operations/operatorname.mdx) | ✅ | Operator identifier used in filter definitions | eq | +| `value_type` | [operations.ValueType](../operations/valuetype.mdx) | ✅ | Whether the operator expects a single value or an array | | \ No newline at end of file diff --git a/docs/operations/orderby.mdx b/docs/operations/orderby.mdx index d2239ff9d..f15afa9e3 100644 --- a/docs/operations/orderby.mdx +++ b/docs/operations/orderby.mdx @@ -6,5 +6,5 @@ title: "OrderBy" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `direction` | [operations.Direction](../operations/direction.mdx) | :heavy_check_mark: | N/A | | -| `field` | *str* | :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](../operations/direction.mdx) | ✅ | N/A | | +| `field` | *str* | ✅ | 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/operations/promotecontainerfileglobals.mdx b/docs/operations/promotecontainerfileglobals.mdx index f1aa90ac4..9bc4f4ea3 100644 --- a/docs/operations/promotecontainerfileglobals.mdx +++ b/docs/operations/promotecontainerfileglobals.mdx @@ -6,6 +6,6 @@ title: "PromoteContainerFileGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/promotecontainerfilerequest.mdx b/docs/operations/promotecontainerfilerequest.mdx index a14427c49..31730e276 100644 --- a/docs/operations/promotecontainerfilerequest.mdx +++ b/docs/operations/promotecontainerfilerequest.mdx @@ -6,8 +6,8 @@ title: "PromoteContainerFileRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `container_id` | *str* | :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 | -| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `container_id` | *str* | ✅ | 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 | +| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/operations/prompttokensdetails.mdx b/docs/operations/prompttokensdetails.mdx index 0f0b54e43..edbbce363 100644 --- a/docs/operations/prompttokensdetails.mdx +++ b/docs/operations/prompttokensdetails.mdx @@ -9,8 +9,8 @@ Per-modality token breakdown. Only present when the input contains 2+ modalities | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `audio_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of audio tokens in the input | | -| `file_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of file/document tokens in the input | | -| `image_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of image tokens in the input | 258 | -| `text_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of text tokens in the input | 8 | -| `video_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file +| `audio_tokens` | *Optional[int]* | ➖ | Number of audio tokens in the input | | +| `file_tokens` | *Optional[int]* | ➖ | Number of file/document tokens in the input | | +| `image_tokens` | *Optional[int]* | ➖ | Number of image tokens in the input | 258 | +| `text_tokens` | *Optional[int]* | ➖ | Number of text tokens in the input | 8 | +| `video_tokens` | *Optional[int]* | ➖ | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/operations/provisioninternglobals.mdx b/docs/operations/provisioninternglobals.mdx index 5e790162a..05197d7f4 100644 --- a/docs/operations/provisioninternglobals.mdx +++ b/docs/operations/provisioninternglobals.mdx @@ -6,6 +6,6 @@ title: "ProvisionInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/provisioninternrequest.mdx b/docs/operations/provisioninternrequest.mdx index 5c14eb74f..19527e6ea 100644 --- a/docs/operations/provisioninternrequest.mdx +++ b/docs/operations/provisioninternrequest.mdx @@ -6,7 +6,7 @@ title: "ProvisionInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | 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/operations/queryanalyticsdata2.mdx b/docs/operations/queryanalyticsdata2.mdx index 669a0894f..3901d64bb 100644 --- a/docs/operations/queryanalyticsdata2.mdx +++ b/docs/operations/queryanalyticsdata2.mdx @@ -6,7 +6,7 @@ title: "QueryAnalyticsData2" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cached_at` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `data` | List[[operations.QueryAnalyticsData1](../operations/queryanalyticsdata1.mdx)] | :heavy_check_mark: | N/A | -| `metadata` | [operations.Metadata](../operations/metadata.mdx) | :heavy_check_mark: | N/A | -| `warnings` | List[*str*] | :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 +| `cached_at` | *Optional[float]* | ➖ | N/A | +| `data` | List[[operations.QueryAnalyticsData1](../operations/queryanalyticsdata1.mdx)] | ✅ | N/A | +| `metadata` | [operations.Metadata](../operations/metadata.mdx) | ✅ | N/A | +| `warnings` | List[*str*] | ➖ | 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/operations/queryanalyticsglobals.mdx b/docs/operations/queryanalyticsglobals.mdx index d808bb399..7f9c63bec 100644 --- a/docs/operations/queryanalyticsglobals.mdx +++ b/docs/operations/queryanalyticsglobals.mdx @@ -6,6 +6,6 @@ title: "QueryAnalyticsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/queryanalyticsrequest.mdx b/docs/operations/queryanalyticsrequest.mdx index 5b3c7c98d..08ca67e33 100644 --- a/docs/operations/queryanalyticsrequest.mdx +++ b/docs/operations/queryanalyticsrequest.mdx @@ -6,7 +6,7 @@ title: "QueryAnalyticsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `request_body` | [operations.QueryAnalyticsRequestBody](../operations/queryanalyticsrequestbody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `request_body` | [operations.QueryAnalyticsRequestBody](../operations/queryanalyticsrequestbody.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/queryanalyticsrequestbody.mdx b/docs/operations/queryanalyticsrequestbody.mdx index ceec61fa2..0b9ab4fef 100644 --- a/docs/operations/queryanalyticsrequestbody.mdx +++ b/docs/operations/queryanalyticsrequestbody.mdx @@ -6,13 +6,13 @@ title: "QueryAnalyticsRequestBody" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `classifier_dimensions` | [Optional[operations.ClassifierDimensions]](../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. | | -| `classifier_filters` | [Optional[operations.ClassifierFilters]](../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` | List[*str*] | :heavy_minus_sign: | N/A | | -| `filters` | List[[operations.Filter](../operations/filter_.mdx)] | :heavy_minus_sign: | N/A | | -| `granularity` | *Optional[str]* | :heavy_minus_sign: | Time granularity | day | -| `group_limit` | *Optional[int]* | :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` | *Optional[int]* | :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` | List[*str*] | :heavy_check_mark: | N/A | | -| `order_by` | [Optional[operations.OrderBy]](../operations/orderby.mdx) | :heavy_minus_sign: | N/A | | -| `time_range` | [Optional[operations.TimeRange]](../operations/timerange.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `classifier_dimensions` | [Optional[operations.ClassifierDimensions]](../operations/classifierdimensions.mdx) | ➖ | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | +| `classifier_filters` | [Optional[operations.ClassifierFilters]](../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` | List[*str*] | ➖ | N/A | | +| `filters` | List[[operations.Filter](../operations/filter_.mdx)] | ➖ | N/A | | +| `granularity` | *Optional[str]* | ➖ | Time granularity | day | +| `group_limit` | *Optional[int]* | ➖ | 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` | *Optional[int]* | ➖ | 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` | List[*str*] | ✅ | N/A | | +| `order_by` | [Optional[operations.OrderBy]](../operations/orderby.mdx) | ➖ | N/A | | +| `time_range` | [Optional[operations.TimeRange]](../operations/timerange.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/operations/queryanalyticsresponse.mdx b/docs/operations/queryanalyticsresponse.mdx index 6c45e2170..a5d3e8568 100644 --- a/docs/operations/queryanalyticsresponse.mdx +++ b/docs/operations/queryanalyticsresponse.mdx @@ -9,4 +9,4 @@ Analytics query results | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [operations.QueryAnalyticsData2](../operations/queryanalyticsdata2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [operations.QueryAnalyticsData2](../operations/queryanalyticsdata2.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/ratelimit.mdx b/docs/operations/ratelimit.mdx index f1aa5276e..9f3599e56 100644 --- a/docs/operations/ratelimit.mdx +++ b/docs/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` | *str* | :heavy_check_mark: | Rate limit interval | 1h | -| `note` | *str* | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | -| `requests` | *int* | :heavy_check_mark: | Number of requests allowed per interval | 1000 | \ No newline at end of file +| `interval` | *str* | ✅ | Rate limit interval | 1h | +| `note` | *str* | ✅ | Note about the rate limit | This field is deprecated and safe to ignore. | +| `requests` | *int* | ✅ | Number of requests allowed per interval | 1000 | \ No newline at end of file diff --git a/docs/operations/result.mdx b/docs/operations/result.mdx index 510072b9f..9a0d2a076 100644 --- a/docs/operations/result.mdx +++ b/docs/operations/result.mdx @@ -9,6 +9,6 @@ A single rerank result | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `document` | [operations.DocumentResponse](../operations/documentresponse.mdx) | :heavy_check_mark: | The document object echoing the original input (text and/or image) | | -| `index` | *int* | :heavy_check_mark: | Index of the document in the original input list | 0 | -| `relevance_score` | *float* | :heavy_check_mark: | Relevance score of the document to the query | 0.98 | \ No newline at end of file +| `document` | [operations.DocumentResponse](../operations/documentresponse.mdx) | ✅ | The document object echoing the original input (text and/or image) | | +| `index` | *int* | ✅ | Index of the document in the original input list | 0 | +| `relevance_score` | *float* | ✅ | Relevance score of the document to the query | 0.98 | \ No newline at end of file diff --git a/docs/operations/sendchatcompletionrequestglobals.mdx b/docs/operations/sendchatcompletionrequestglobals.mdx index 290c9540b..ec68ddea4 100644 --- a/docs/operations/sendchatcompletionrequestglobals.mdx +++ b/docs/operations/sendchatcompletionrequestglobals.mdx @@ -6,6 +6,6 @@ title: "SendChatCompletionRequestGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/sendchatcompletionrequestrequest.mdx b/docs/operations/sendchatcompletionrequestrequest.mdx index bd3e6d5c1..a06e2f6ea 100644 --- a/docs/operations/sendchatcompletionrequestrequest.mdx +++ b/docs/operations/sendchatcompletionrequestrequest.mdx @@ -6,8 +6,8 @@ title: "SendChatCompletionRequestRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../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 | -| `chat_request` | [components.ChatRequest](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../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 | +| `chat_request` | [components.ChatRequest](../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/operations/signinterndaemonaccessrequestglobals.mdx b/docs/operations/signinterndaemonaccessrequestglobals.mdx index 44569250d..38e573620 100644 --- a/docs/operations/signinterndaemonaccessrequestglobals.mdx +++ b/docs/operations/signinterndaemonaccessrequestglobals.mdx @@ -6,6 +6,6 @@ title: "SignInternDaemonAccessRequestGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/signinterndaemonaccessrequestrequest.mdx b/docs/operations/signinterndaemonaccessrequestrequest.mdx index 1816b6092..bad498735 100644 --- a/docs/operations/signinterndaemonaccessrequestrequest.mdx +++ b/docs/operations/signinterndaemonaccessrequestrequest.mdx @@ -6,8 +6,8 @@ title: "SignInternDaemonAccessRequestRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `sign_intern_daemon_request` | [components.SignInternDaemonRequest](../components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `sign_intern_daemon_request` | [components.SignInternDaemonRequest](../components/signinterndaemonrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/operations/signinterndaemonaccessrequestresponse.mdx b/docs/operations/signinterndaemonaccessrequestresponse.mdx index 83bc490dc..6e1f966ae 100644 --- a/docs/operations/signinterndaemonaccessrequestresponse.mdx +++ b/docs/operations/signinterndaemonaccessrequestresponse.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonAccessRequestResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | | -| `result` | [components.SignInternDaemonResponse](../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` | Dict[str, List[*str*]] | ✅ | N/A | | +| `result` | [components.SignInternDaemonResponse](../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/operations/signinterndaemonrequestglobals.mdx b/docs/operations/signinterndaemonrequestglobals.mdx index 488b9b063..4d4018dbd 100644 --- a/docs/operations/signinterndaemonrequestglobals.mdx +++ b/docs/operations/signinterndaemonrequestglobals.mdx @@ -6,6 +6,6 @@ title: "SignInternDaemonRequestGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/signinterndaemonrequestrequest.mdx b/docs/operations/signinterndaemonrequestrequest.mdx index afc21adef..29a5ad132 100644 --- a/docs/operations/signinterndaemonrequestrequest.mdx +++ b/docs/operations/signinterndaemonrequestrequest.mdx @@ -6,8 +6,8 @@ title: "SignInternDaemonRequestRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `sign_intern_daemon_request` | [components.SignInternDaemonRequest](../components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `sign_intern_daemon_request` | [components.SignInternDaemonRequest](../components/signinterndaemonrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/operations/signinterndaemonrequestresponse.mdx b/docs/operations/signinterndaemonrequestresponse.mdx index 068696580..7d4277674 100644 --- a/docs/operations/signinterndaemonrequestresponse.mdx +++ b/docs/operations/signinterndaemonrequestresponse.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonRequestResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `headers` | Dict[str, List[*str*]] | :heavy_check_mark: | N/A | | -| `result` | [components.SignInternDaemonResponse](../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` | Dict[str, List[*str*]] | ✅ | N/A | | +| `result` | [components.SignInternDaemonResponse](../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/operations/storeinternvaultsecretglobals.mdx b/docs/operations/storeinternvaultsecretglobals.mdx index e7c3b3f7a..799434f5c 100644 --- a/docs/operations/storeinternvaultsecretglobals.mdx +++ b/docs/operations/storeinternvaultsecretglobals.mdx @@ -6,6 +6,6 @@ title: "StoreInternVaultSecretGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/storeinternvaultsecretrequest.mdx b/docs/operations/storeinternvaultsecretrequest.mdx index fe38c09ab..f1df8d4ba 100644 --- a/docs/operations/storeinternvaultsecretrequest.mdx +++ b/docs/operations/storeinternvaultsecretrequest.mdx @@ -6,9 +6,9 @@ title: "StoreInternVaultSecretRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *str* | :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 | -| `vault_secret_write_request` | [components.VaultSecretWriteRequest](../components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `vault_secret_write_request` | [components.VaultSecretWriteRequest](../components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file diff --git a/docs/operations/storevaultsecretglobals.mdx b/docs/operations/storevaultsecretglobals.mdx index 6cb21606c..22bcb1e07 100644 --- a/docs/operations/storevaultsecretglobals.mdx +++ b/docs/operations/storevaultsecretglobals.mdx @@ -6,6 +6,6 @@ title: "StoreVaultSecretGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/storevaultsecretrequest.mdx b/docs/operations/storevaultsecretrequest.mdx index e8571eae3..64ffb5bd7 100644 --- a/docs/operations/storevaultsecretrequest.mdx +++ b/docs/operations/storevaultsecretrequest.mdx @@ -6,8 +6,8 @@ title: "StoreVaultSecretRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `name` | *str* | :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 | -| `vault_secret_write_request` | [components.VaultSecretWriteRequest](../components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `vault_secret_write_request` | [components.VaultSecretWriteRequest](../components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file diff --git a/docs/operations/submitgenerationfeedbackglobals.mdx b/docs/operations/submitgenerationfeedbackglobals.mdx index bbd731b6f..44e60ea92 100644 --- a/docs/operations/submitgenerationfeedbackglobals.mdx +++ b/docs/operations/submitgenerationfeedbackglobals.mdx @@ -6,6 +6,6 @@ title: "SubmitGenerationFeedbackGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/submitgenerationfeedbackrequest.mdx b/docs/operations/submitgenerationfeedbackrequest.mdx index 18f5cc3e2..507162ed7 100644 --- a/docs/operations/submitgenerationfeedbackrequest.mdx +++ b/docs/operations/submitgenerationfeedbackrequest.mdx @@ -6,7 +6,7 @@ title: "SubmitGenerationFeedbackRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `submit_generation_feedback_request` | [components.SubmitGenerationFeedbackRequest](../components/submitgenerationfeedbackrequest.mdx) | :heavy_check_mark: | N/A | \{
"category": "incorrect_response",
"comment": "The model repeated the same paragraph three times.",
"generation_id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `submit_generation_feedback_request` | [components.SubmitGenerationFeedbackRequest](../components/submitgenerationfeedbackrequest.mdx) | ✅ | N/A | \{
"category": "incorrect_response",
"comment": "The model repeated the same paragraph three times.",
"generation_id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG"
} | \ No newline at end of file diff --git a/docs/operations/suspendinternglobals.mdx b/docs/operations/suspendinternglobals.mdx index 3837a6174..1d1c22fbb 100644 --- a/docs/operations/suspendinternglobals.mdx +++ b/docs/operations/suspendinternglobals.mdx @@ -6,6 +6,6 @@ title: "SuspendInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/suspendinternrequest.mdx b/docs/operations/suspendinternrequest.mdx index d039292f1..6bd3bcbf4 100644 --- a/docs/operations/suspendinternrequest.mdx +++ b/docs/operations/suspendinternrequest.mdx @@ -6,7 +6,7 @@ title: "SuspendInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | 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/operations/timerange.mdx b/docs/operations/timerange.mdx index a7077e81b..4cce4dcbb 100644 --- a/docs/operations/timerange.mdx +++ b/docs/operations/timerange.mdx @@ -6,5 +6,5 @@ title: "TimeRange" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `end` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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/operations/updatebyokkeyglobals.mdx b/docs/operations/updatebyokkeyglobals.mdx index 905abf791..676e2ae49 100644 --- a/docs/operations/updatebyokkeyglobals.mdx +++ b/docs/operations/updatebyokkeyglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateBYOKKeyGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updatebyokkeyrequest.mdx b/docs/operations/updatebyokkeyrequest.mdx index 546e001df..fa8d4fa00 100644 --- a/docs/operations/updatebyokkeyrequest.mdx +++ b/docs/operations/updatebyokkeyrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `update_byok_key_request` | [components.UpdateBYOKKeyRequest](../components/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `update_byok_key_request` | [components.UpdateBYOKKeyRequest](../components/updatebyokkeyrequest.mdx) | ✅ | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file diff --git a/docs/operations/updateenduserglobals.mdx b/docs/operations/updateenduserglobals.mdx index de504b1ca..f0004a028 100644 --- a/docs/operations/updateenduserglobals.mdx +++ b/docs/operations/updateenduserglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateEndUserGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateenduserrequest.mdx b/docs/operations/updateenduserrequest.mdx index 6ff8bd561..76b7792cf 100644 --- a/docs/operations/updateenduserrequest.mdx +++ b/docs/operations/updateenduserrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `user` | *str* | :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 | -| `update_end_user_request` | [components.UpdateEndUserRequest](../components/updateenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"is_active": true
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `user` | *str* | ✅ | 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 | +| `update_end_user_request` | [components.UpdateEndUserRequest](../components/updateenduserrequest.mdx) | ✅ | N/A | \{
"is_active": true
} | \ No newline at end of file diff --git a/docs/operations/updateguardrailglobals.mdx b/docs/operations/updateguardrailglobals.mdx index 0cd4bcb1e..0897cc9c1 100644 --- a/docs/operations/updateguardrailglobals.mdx +++ b/docs/operations/updateguardrailglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateGuardrailGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateguardrailrequest.mdx b/docs/operations/updateguardrailrequest.mdx index b89a6072a..5dcca590d 100644 --- a/docs/operations/updateguardrailrequest.mdx +++ b/docs/operations/updateguardrailrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `update_guardrail_request` | [components.UpdateGuardrailRequest](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | +| `update_guardrail_request` | [components.UpdateGuardrailRequest](../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/operations/updateinternglobals.mdx b/docs/operations/updateinternglobals.mdx index ef2e16315..cb55402b0 100644 --- a/docs/operations/updateinternglobals.mdx +++ b/docs/operations/updateinternglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateInternGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateinternrequest.mdx b/docs/operations/updateinternrequest.mdx index 059a2165b..179bb1dfa 100644 --- a/docs/operations/updateinternrequest.mdx +++ b/docs/operations/updateinternrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `update_intern_request` | [components.UpdateInternRequest](../components/updateinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `update_intern_request` | [components.UpdateInternRequest](../components/updateinternrequest.mdx) | ✅ | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | \ No newline at end of file diff --git a/docs/operations/updatekeysdata.mdx b/docs/operations/updatekeysdata.mdx index 46e464000..8ecbb6a93 100644 --- a/docs/operations/updatekeysdata.mdx +++ b/docs/operations/updatekeysdata.mdx @@ -9,26 +9,26 @@ The updated API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | :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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `external_user` | *Nullable[str]* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byok_usage` | *float* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byok_usage_daily` | *float* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byok_usage_monthly` | *float* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byok_usage_weekly` | *float* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `created_at` | *str* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creator_user_id` | *Nullable[str]* | ✅ | 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 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `external_user` | *Nullable[str]* | ✅ | Partner's end-user identifier used for attribution. | null | +| `hash` | *str* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `include_byok_in_limit` | *bool* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `label` | *str* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `last_used_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ✅ | 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` | *Nullable[float]* | ✅ | Spending limit for the API key in USD | 100 | +| `limit_remaining` | *Nullable[float]* | ✅ | Remaining spending limit in USD | 74.5 | +| `limit_reset` | *Nullable[str]* | ✅ | Type of limit reset for the API key | monthly | +| `name` | *str* | ✅ | Name of the API key | My Production Key | +| `updated_at` | *Nullable[str]* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *float* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usage_daily` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usage_monthly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usage_weekly` | *float* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspace_id` | *str* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/operations/updatekeysglobals.mdx b/docs/operations/updatekeysglobals.mdx index 2b4abc3fc..a1cd92e3c 100644 --- a/docs/operations/updatekeysglobals.mdx +++ b/docs/operations/updatekeysglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateKeysGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updatekeysrequest.mdx b/docs/operations/updatekeysrequest.mdx index e6d3d7f01..e3ea21921 100644 --- a/docs/operations/updatekeysrequest.mdx +++ b/docs/operations/updatekeysrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `request_body` | [operations.UpdateKeysRequestBody](../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 +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `hash` | *str* | ✅ | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `request_body` | [operations.UpdateKeysRequestBody](../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/operations/updatekeysrequestbody.mdx b/docs/operations/updatekeysrequestbody.mdx index bc08a2d46..9cf47d247 100644 --- a/docs/operations/updatekeysrequestbody.mdx +++ b/docs/operations/updatekeysrequestbody.mdx @@ -6,9 +6,9 @@ title: "UpdateKeysRequestBody" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to disable the API key | false | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../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` | *Optional[str]* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Move the API key to this workspace. The key keeps its value; guardrail selections move with it, while other workspace-scoped settings (presets, BYOK keys, broadcast destinations, routing rules) do not. Sending the key's current workspace is a no-op. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `disabled` | *Optional[bool]* | ➖ | Whether to disable the API key | false | +| `include_byok_in_limit` | *Optional[bool]* | ➖ | Whether to include BYOK usage in the limit | true | +| `limit` | *OptionalNullable[float]* | ➖ | New spending limit for the API key in USD | 75 | +| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../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` | *Optional[str]* | ➖ | New name for the API key | Updated API Key Name | +| `workspace_id` | *Optional[str]* | ➖ | Move the API key to this workspace. The key keeps its value; guardrail selections move with it, while other workspace-scoped settings (presets, BYOK keys, broadcast destinations, routing rules) do not. Sending the key's current workspace is a no-op. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/operations/updatekeysresponse.mdx b/docs/operations/updatekeysresponse.mdx index 9440f9f6b..1512882c6 100644 --- a/docs/operations/updatekeysresponse.mdx +++ b/docs/operations/updatekeysresponse.mdx @@ -9,4 +9,4 @@ API key updated successfully | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.UpdateKeysData](../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](../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/operations/updateobservabilitydestinationglobals.mdx b/docs/operations/updateobservabilitydestinationglobals.mdx index f5a0ba069..4cc38c4a3 100644 --- a/docs/operations/updateobservabilitydestinationglobals.mdx +++ b/docs/operations/updateobservabilitydestinationglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateObservabilityDestinationGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateobservabilitydestinationrequest.mdx b/docs/operations/updateobservabilitydestinationrequest.mdx index 169263831..1f03ef4d8 100644 --- a/docs/operations/updateobservabilitydestinationrequest.mdx +++ b/docs/operations/updateobservabilitydestinationrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `update_observability_destination_request` | [components.UpdateObservabilityDestinationRequest](../components/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `update_observability_destination_request` | [components.UpdateObservabilityDestinationRequest](../components/updateobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file diff --git a/docs/operations/updateorganizationsettingsglobals.mdx b/docs/operations/updateorganizationsettingsglobals.mdx index 6c32aff3a..f9a837442 100644 --- a/docs/operations/updateorganizationsettingsglobals.mdx +++ b/docs/operations/updateorganizationsettingsglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateOrganizationSettingsGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateorganizationsettingsrequest.mdx b/docs/operations/updateorganizationsettingsrequest.mdx index 014eb8dbe..b35d1c40a 100644 --- a/docs/operations/updateorganizationsettingsrequest.mdx +++ b/docs/operations/updateorganizationsettingsrequest.mdx @@ -6,7 +6,7 @@ title: "UpdateOrganizationSettingsRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `update_organization_settings_request` | [components.UpdateOrganizationSettingsRequest](../components/updateorganizationsettingsrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `update_organization_settings_request` | [components.UpdateOrganizationSettingsRequest](../components/updateorganizationsettingsrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/updateorganizationsettingsresponse.mdx b/docs/operations/updateorganizationsettingsresponse.mdx index b811bffe1..ccc6b67ea 100644 --- a/docs/operations/updateorganizationsettingsresponse.mdx +++ b/docs/operations/updateorganizationsettingsresponse.mdx @@ -9,4 +9,4 @@ Organization settings updated successfully | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [components.OrganizationSettings](../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](../components/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file diff --git a/docs/operations/updateprivateendpointglobals.mdx b/docs/operations/updateprivateendpointglobals.mdx index 3624f9a24..99aa01601 100644 --- a/docs/operations/updateprivateendpointglobals.mdx +++ b/docs/operations/updateprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "UpdatePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateprivateendpointpricingglobals.mdx b/docs/operations/updateprivateendpointpricingglobals.mdx index 3fea3054b..6ad2cba06 100644 --- a/docs/operations/updateprivateendpointpricingglobals.mdx +++ b/docs/operations/updateprivateendpointpricingglobals.mdx @@ -6,6 +6,6 @@ title: "UpdatePrivateEndpointPricingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateprivateendpointpricingrequest.mdx b/docs/operations/updateprivateendpointpricingrequest.mdx index 4b77bff2c..50e3535fd 100644 --- a/docs/operations/updateprivateendpointpricingrequest.mdx +++ b/docs/operations/updateprivateendpointpricingrequest.mdx @@ -6,8 +6,8 @@ title: "UpdatePrivateEndpointPricingRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `update_private_endpoint_pricing_request` | [components.UpdatePrivateEndpointPricingRequest](../components/updateprivateendpointpricingrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `update_private_endpoint_pricing_request` | [components.UpdatePrivateEndpointPricingRequest](../components/updateprivateendpointpricingrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/operations/updateprivateendpointrequest.mdx b/docs/operations/updateprivateendpointrequest.mdx index 45632457e..216dd97dc 100644 --- a/docs/operations/updateprivateendpointrequest.mdx +++ b/docs/operations/updateprivateendpointrequest.mdx @@ -6,8 +6,8 @@ title: "UpdatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `update_private_endpoint_request` | [components.UpdatePrivateEndpointRequest](../components/updateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `update_private_endpoint_request` | [components.UpdatePrivateEndpointRequest](../components/updateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/operations/updatescimgroupmappingglobals.mdx b/docs/operations/updatescimgroupmappingglobals.mdx index a8893db66..1b82d6be7 100644 --- a/docs/operations/updatescimgroupmappingglobals.mdx +++ b/docs/operations/updatescimgroupmappingglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateScimGroupMappingGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updatescimgroupmappingrequest.mdx b/docs/operations/updatescimgroupmappingrequest.mdx index a2785d524..c341f7622 100644 --- a/docs/operations/updatescimgroupmappingrequest.mdx +++ b/docs/operations/updatescimgroupmappingrequest.mdx @@ -6,8 +6,8 @@ title: "UpdateScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `id` | *str* | :heavy_check_mark: | N/A | -| `update_scim_group_mapping_request` | [components.UpdateScimGroupMappingRequest](../components/updatescimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `id` | *str* | ✅ | N/A | +| `update_scim_group_mapping_request` | [components.UpdateScimGroupMappingRequest](../components/updatescimgroupmappingrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/updateworkspaceglobals.mdx b/docs/operations/updateworkspaceglobals.mdx index 34ddab96d..e1c253c39 100644 --- a/docs/operations/updateworkspaceglobals.mdx +++ b/docs/operations/updateworkspaceglobals.mdx @@ -6,6 +6,6 @@ title: "UpdateWorkspaceGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/updateworkspacerequest.mdx b/docs/operations/updateworkspacerequest.mdx index 086cdf63d..993917254 100644 --- a/docs/operations/updateworkspacerequest.mdx +++ b/docs/operations/updateworkspacerequest.mdx @@ -6,8 +6,8 @@ title: "UpdateWorkspaceRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `update_workspace_request` | [components.UpdateWorkspaceRequest](../components/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `update_workspace_request` | [components.UpdateWorkspaceRequest](../components/updateworkspacerequest.mdx) | ✅ | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file diff --git a/docs/operations/uploadfilefile.mdx b/docs/operations/uploadfilefile.mdx index f07c77ddf..454042271 100644 --- a/docs/operations/uploadfilefile.mdx +++ b/docs/operations/uploadfilefile.mdx @@ -6,6 +6,6 @@ title: "UploadFileFile" | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `file_name` | *str* | :heavy_check_mark: | N/A | -| `content` | *Union[bytes, IO[bytes], io.IOBase]* | :heavy_check_mark: | N/A | -| `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `file_name` | *str* | ✅ | N/A | +| `content` | *Union[bytes, IO[bytes], io.IOBase]* | ✅ | N/A | +| `content_type` | *Optional[str]* | ➖ | N/A | \ No newline at end of file diff --git a/docs/operations/uploadfileglobals.mdx b/docs/operations/uploadfileglobals.mdx index 41aa595e2..534573027 100644 --- a/docs/operations/uploadfileglobals.mdx +++ b/docs/operations/uploadfileglobals.mdx @@ -6,6 +6,6 @@ title: "UploadFileGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/uploadfilerequest.mdx b/docs/operations/uploadfilerequest.mdx index 16d9fbce0..cc87b0f26 100644 --- a/docs/operations/uploadfilerequest.mdx +++ b/docs/operations/uploadfilerequest.mdx @@ -6,9 +6,9 @@ title: "UploadFileRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../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 | -| `request_body` | [operations.UploadFileRequestBody](../operations/uploadfilerequestbody.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../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 | +| `request_body` | [operations.UploadFileRequestBody](../operations/uploadfilerequestbody.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/operations/uploadfilerequestbody.mdx b/docs/operations/uploadfilerequestbody.mdx index e91f2d375..adf966ae0 100644 --- a/docs/operations/uploadfilerequestbody.mdx +++ b/docs/operations/uploadfilerequestbody.mdx @@ -6,4 +6,4 @@ title: "UploadFileRequestBody" | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `file` | [operations.UploadFileFile](../operations/uploadfilefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file` | [operations.UploadFileFile](../operations/uploadfilefile.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/operations/upsertworkspacebudgetglobals.mdx b/docs/operations/upsertworkspacebudgetglobals.mdx index 67a0d7d1d..a9b8e0266 100644 --- a/docs/operations/upsertworkspacebudgetglobals.mdx +++ b/docs/operations/upsertworkspacebudgetglobals.mdx @@ -6,6 +6,6 @@ title: "UpsertWorkspaceBudgetGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/upsertworkspacebudgetrequest.mdx b/docs/operations/upsertworkspacebudgetrequest.mdx index 6c23bcff4..fd6c4250d 100644 --- a/docs/operations/upsertworkspacebudgetrequest.mdx +++ b/docs/operations/upsertworkspacebudgetrequest.mdx @@ -6,9 +6,9 @@ title: "UpsertWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `upsert_workspace_budget_request` | [components.UpsertWorkspaceBudgetRequest](../components/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `upsert_workspace_budget_request` | [components.UpsertWorkspaceBudgetRequest](../components/upsertworkspacebudgetrequest.mdx) | ✅ | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | \ No newline at end of file diff --git a/docs/operations/validateprivateendpointglobals.mdx b/docs/operations/validateprivateendpointglobals.mdx index e539875f6..af7c2932f 100644 --- a/docs/operations/validateprivateendpointglobals.mdx +++ b/docs/operations/validateprivateendpointglobals.mdx @@ -6,6 +6,6 @@ title: "ValidatePrivateEndpointGlobals" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/operations/validateprivateendpointrequest.mdx b/docs/operations/validateprivateendpointrequest.mdx index d61a27f50..12245fab6 100644 --- a/docs/operations/validateprivateendpointrequest.mdx +++ b/docs/operations/validateprivateendpointrequest.mdx @@ -6,8 +6,8 @@ title: "ValidatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `validate_private_endpoint_request` | [components.ValidatePrivateEndpointRequest](../components/validateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `validate_private_endpoint_request` | [components.ValidatePrivateEndpointRequest](../components/validateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/sdks/analytics/README.mdx b/docs/sdks/analytics/README.mdx index c16347066..3f0c2dcf2 100644 --- a/docs/sdks/analytics/README.mdx +++ b/docs/sdks/analytics/README.mdx @@ -42,8 +42,8 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `request` | [operations.GetUserActivityRequest](../../operations/getuseractivityrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `request` | [operations.GetUserActivityRequest](../../operations/getuseractivityrequest.mdx) | ✅ | The request object to use for the request. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -89,10 +89,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -144,20 +144,20 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metrics` | List[*str*] | :heavy_check_mark: | N/A | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `classifier_dimensions` | [Optional[operations.ClassifierDimensions]](../../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. | | -| `classifier_filters` | [Optional[operations.ClassifierFilters]](../../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` | List[*str*] | :heavy_minus_sign: | N/A | | -| `filters` | List[[operations.Filter](../../operations/filter_.mdx)] | :heavy_minus_sign: | N/A | | -| `granularity` | *Optional[str]* | :heavy_minus_sign: | Time granularity | day | -| `group_limit` | *Optional[int]* | :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` | *Optional[int]* | :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. | | -| `order_by` | [Optional[operations.OrderBy]](../../operations/orderby.mdx) | :heavy_minus_sign: | N/A | | -| `time_range` | [Optional[operations.TimeRange]](../../operations/timerange.mdx) | :heavy_minus_sign: | N/A | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `metrics` | List[*str*] | ✅ | N/A | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `classifier_dimensions` | [Optional[operations.ClassifierDimensions]](../../operations/classifierdimensions.mdx) | ➖ | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | +| `classifier_filters` | [Optional[operations.ClassifierFilters]](../../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` | List[*str*] | ➖ | N/A | | +| `filters` | List[[operations.Filter](../../operations/filter_.mdx)] | ➖ | N/A | | +| `granularity` | *Optional[str]* | ➖ | Time granularity | day | +| `group_limit` | *Optional[int]* | ➖ | 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` | *Optional[int]* | ➖ | 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. | | +| `order_by` | [Optional[operations.OrderBy]](../../operations/orderby.mdx) | ➖ | N/A | | +| `time_range` | [Optional[operations.TimeRange]](../../operations/timerange.mdx) | ➖ | N/A | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/apikeys/README.mdx b/docs/sdks/apikeys/README.mdx index 959c9469a..6cdaed22a 100644 --- a/docs/sdks/apikeys/README.mdx +++ b/docs/sdks/apikeys/README.mdx @@ -45,10 +45,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -91,14 +91,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `include_disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `include_expired` | *Optional[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[int]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `include_disabled` | *Optional[bool]* | ➖ | Whether to include disabled API keys in the response | false | +| `include_expired` | *Optional[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[int]* | ➖ | Number of API keys to skip for pagination | 0 | +| `workspace_id` | *Optional[str]* | ➖ | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -144,18 +144,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `creator_user_id` | *OptionalNullable[str]* | :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 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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` | [Optional[operations.External]](../../operations/external.mdx) | :heavy_minus_sign: | Optional partner-defined identity associated with the created API key. | | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../../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 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | ✅ | Name for the new API key | My New API Key | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `creator_user_id` | *OptionalNullable[str]* | ➖ | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | 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` | [Optional[operations.External]](../../operations/external.mdx) | ➖ | Optional partner-defined identity associated with the created API key. | | +| `include_byok_in_limit` | *Optional[bool]* | ➖ | Whether to include BYOK usage in the limit | true | +| `limit` | *OptionalNullable[float]* | ➖ | Optional spending limit for the API key in USD | 50 | +| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../../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 | +| `workspace_id` | *Optional[str]* | ➖ | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -201,11 +201,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `hash` | *str* | ✅ | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -250,11 +250,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `hash` | *str* | ✅ | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -325,17 +325,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to disable the API key | false | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../../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` | *Optional[str]* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Move the API key to this workspace. The key keeps its value; guardrail selections move with it, while other workspace-scoped settings (presets, BYOK keys, broadcast destinations, routing rules) do not. Sending the key's current workspace is a no-op. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `hash` | *str* | ✅ | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `disabled` | *Optional[bool]* | ➖ | Whether to disable the API key | false | +| `include_byok_in_limit` | *Optional[bool]* | ➖ | Whether to include BYOK usage in the limit | true | +| `limit` | *OptionalNullable[float]* | ➖ | New spending limit for the API key in USD | 75 | +| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../../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` | *Optional[str]* | ➖ | New name for the API key | Updated API Key Name | +| `workspace_id` | *Optional[str]* | ➖ | Move the API key to this workspace. The key keeps its value; guardrail selections move with it, while other workspace-scoped settings (presets, BYOK keys, broadcast destinations, routing rules) do not. Sending the key's current workspace is a no-op. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/batch/README.mdx b/docs/sdks/batch/README.mdx index 9fb69f19b..c7f0cd1dc 100644 --- a/docs/sdks/batch/README.mdx +++ b/docs/sdks/batch/README.mdx @@ -45,15 +45,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of batches to return, from 1 through 100. | 20 | -| `after` | *Optional[str]* | :heavy_minus_sign: | Batch id from the previous page's `last_id`. | batch_7a4b02 | -| `status` | List[[components.BatchListStatus](../../components/batchliststatus.mdx)] | :heavy_minus_sign: | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | -| `created_after` | [Optional[components.BatchListTimestamp]](../../components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | -| `created_before` | [Optional[components.BatchListTimestamp]](../../components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Maximum number of batches to return, from 1 through 100. | 20 | +| `after` | *Optional[str]* | ➖ | Batch id from the previous page's `last_id`. | batch_7a4b02 | +| `status` | List[[components.BatchListStatus](../../components/batchliststatus.mdx)] | ➖ | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | +| `created_after` | [Optional[components.BatchListTimestamp]](../../components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | +| `created_before` | [Optional[components.BatchListTimestamp]](../../components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -214,15 +214,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `endpoint` | [components.Endpoint](../../components/endpoint.mdx) | :heavy_check_mark: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `requests` | List[[components.Request](../../components/request.mdx)] | :heavy_check_mark: | N/A | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `completion_window` | [Optional[components.BatchSubmitBodyCompletionWindow]](../../components/batchsubmitbodycompletionwindow.mdx) | :heavy_minus_sign: | N/A | | -| `provider` | [OptionalNullable[components.BatchProviderPreferences]](../../components/batchproviderpreferences.mdx) | :heavy_minus_sign: | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `endpoint` | [components.Endpoint](../../components/endpoint.mdx) | ✅ | N/A | | +| `model` | *str* | ✅ | N/A | | +| `requests` | List[[components.Request](../../components/request.mdx)] | ✅ | N/A | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `completion_window` | [Optional[components.BatchSubmitBodyCompletionWindow]](../../components/batchsubmitbodycompletionwindow.mdx) | ➖ | N/A | | +| `provider` | [OptionalNullable[components.BatchProviderPreferences]](../../components/batchproviderpreferences.mdx) | ➖ | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -265,11 +265,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The batch job id returned from submit. | batch_abc123 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -312,11 +312,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The batch job id returned from submit. | batch_abc123 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/benchmarks/README.mdx b/docs/sdks/benchmarks/README.mdx index 5026ac2a2..46fe09f0c 100644 --- a/docs/sdks/benchmarks/README.mdx +++ b/docs/sdks/benchmarks/README.mdx @@ -40,19 +40,19 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `source` | [Optional[operations.Source]](../../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 | -| `task_type` | [Optional[operations.TaskType]](../../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 | -| `benchmark_type` | [Optional[operations.BenchmarkType]](../../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 | -| `include_run_config` | *Optional[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 | -| `search_engine` | *Optional[str]* | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the search engine used. | exa | -| `search_surface` | [Optional[operations.SearchSurface]](../../operations/searchsurface.mdx) | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | -| `arena` | [Optional[operations.Arena]](../../operations/arena.mdx) | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | -| `category` | *Optional[str]* | :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 | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of items to return. When omitted, all matching results are returned. | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `source` | [Optional[operations.Source]](../../operations/source.mdx) | ➖ | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | +| `task_type` | [Optional[operations.TaskType]](../../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 | +| `benchmark_type` | [Optional[operations.BenchmarkType]](../../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 | +| `include_run_config` | *Optional[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 | +| `search_engine` | *Optional[str]* | ➖ | OpenRouter search benchmarks only: filter by the search engine used. | exa | +| `search_surface` | [Optional[operations.SearchSurface]](../../operations/searchsurface.mdx) | ➖ | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | +| `arena` | [Optional[operations.Arena]](../../operations/arena.mdx) | ➖ | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | +| `category` | *Optional[str]* | ➖ | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | +| `max_results` | *Optional[int]* | ➖ | Maximum number of items to return. When omitted, all matching results are returned. | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/betaresponses/README.mdx b/docs/sdks/betaresponses/README.mdx index d9ec09c27..d0422a491 100644 --- a/docs/sdks/betaresponses/README.mdx +++ b/docs/sdks/betaresponses/README.mdx @@ -64,50 +64,50 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | -| `input` | [Optional[components.InputsUnion]](../../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[str]* | :heavy_minus_sign: | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :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` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | :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 | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | -| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | -| `user` | *Optional[str]* | :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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | +| `background` | *OptionalNullable[bool]* | ➖ | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | | +| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | ➖ | N/A | | +| `input` | [Optional[components.InputsUnion]](../../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[str]* | ➖ | N/A | | +| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | ➖ | 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` | Dict[str, *str*] | ➖ | 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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `model` | *Optional[str]* | ➖ | N/A | | +| `models` | List[*str*] | ➖ | N/A | | +| `parallel_tool_calls` | *OptionalNullable[bool]* | ➖ | N/A | | +| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | | +| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | ➖ | 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 | +| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | +| `session_id` | *Optional[str]* | ➖ | 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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | N/A | | +| `temperature` | *OptionalNullable[float]* | ➖ | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | +| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | ➖ | N/A | | +| `top_k` | *Optional[int]* | ➖ | N/A | | +| `top_logprobs` | *OptionalNullable[int]* | ➖ | N/A | | +| `top_p` | *OptionalNullable[float]* | ➖ | N/A | | +| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | ➖ | N/A | auto | +| `user` | *Optional[str]* | ➖ | 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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/byok/README.mdx b/docs/sdks/byok/README.mdx index d159c8b23..83fbd3592 100644 --- a/docs/sdks/byok/README.mdx +++ b/docs/sdks/byok/README.mdx @@ -46,14 +46,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :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` | [Optional[operations.Provider]](../../operations/provider.mdx) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | ➖ | 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` | [Optional[operations.Provider]](../../operations/provider.mdx) | ➖ | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -97,23 +97,23 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `key` | *str* | :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... | -| `provider` | [components.BYOKProviderSlug](../../components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_api_key_hashes` | List[*str*] | :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"
] | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declared_region` | [OptionalNullable[components.CreateBYOKKeyRequestDeclaredRegion]](../../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 | -| `declared_zdr` | *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | -| `is_byok_only` | *Optional[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 | -| `is_fallback` | *Optional[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 | -| `is_required` | *Optional[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 | -| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `workspace_id` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `key` | *str* | ✅ | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | +| `provider` | [components.BYOKProviderSlug](../../components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `allowed_api_key_hashes` | List[*str*] | ➖ | 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"
] | +| `allowed_models` | List[*str*] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declared_region` | [OptionalNullable[components.CreateBYOKKeyRequestDeclaredRegion]](../../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 | +| `declared_zdr` | *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` | *Optional[bool]* | ➖ | Whether this credential should be created in a disabled state. | false | +| `is_byok_only` | *Optional[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 | +| `is_fallback` | *Optional[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 | +| `is_required` | *Optional[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 | +| `name` | *OptionalNullable[str]* | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | +| `workspace_id` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -158,11 +158,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -206,11 +206,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -254,22 +254,22 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_api_key_hashes` | List[*str*] | :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"
] | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declared_region` | [OptionalNullable[components.UpdateBYOKKeyRequestDeclaredRegion]](../../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 | -| `declared_zdr` | *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` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential is disabled. | false | -| `is_byok_only` | *Optional[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 | -| `is_fallback` | *Optional[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 | -| `is_required` | *Optional[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` | *Optional[str]* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `allowed_api_key_hashes` | List[*str*] | ➖ | 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"
] | +| `allowed_models` | List[*str*] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowed_user_ids` | List[*str*] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declared_region` | [OptionalNullable[components.UpdateBYOKKeyRequestDeclaredRegion]](../../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 | +| `declared_zdr` | *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` | *Optional[bool]* | ➖ | Whether this credential is disabled. | false | +| `is_byok_only` | *Optional[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 | +| `is_fallback` | *Optional[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 | +| `is_required` | *Optional[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` | *Optional[str]* | ➖ | 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[str]* | ➖ | Optional human-readable name for the credential. | Updated OpenAI Key | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/chat/README.mdx b/docs/sdks/chat/README.mdx index 4179eb9de..83fc358f2 100644 --- a/docs/sdks/chat/README.mdx +++ b/docs/sdks/chat/README.mdx @@ -79,53 +79,53 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `messages` | List[[components.ChatMessages](../../components/chatmessages.mdx)] | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `image_config` | Dict[str, [components.ImageConfig](../../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"
} | -| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | -| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | -| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | -| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `metadata` | Dict[str, *str*] | :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"
} | -| `min_p` | *OptionalNullable[float]* | :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` | List[[components.Modality](../../components/modality.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | -| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../../components/chatrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `prediction` | [OptionalNullable[components.Prediction]](../../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"
} | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [Optional[components.ChatRequestReasoning]](../../components/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../../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 | -| `repetition_penalty` | *OptionalNullable[float]* | :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 | -| `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.mdx) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | -| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../../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 | -| `session_id` | *Optional[str]* | :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[components.Stop]](../../components/stop.mdx) | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.mdx) | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `tool_choice` | [Optional[components.ChatToolChoice]](../../components/chattoolchoice.mdx) | :heavy_minus_sign: | Tool choice configuration | auto | -| `tools` | List[[components.ChatFunctionTool](../../components/chatfunctiontool.mdx)] | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | -| `top_a` | *OptionalNullable[float]* | :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 | -| `top_k` | *OptionalNullable[int]* | :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 | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `messages` | List[[components.ChatMessages](../../components/chatmessages.mdx)] | ✅ | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | ➖ | Frequency penalty (-2.0 to 2.0) | 0 | +| `image_config` | Dict[str, [components.ImageConfig](../../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"
} | +| `logit_bias` | Dict[str, *float*] | ➖ | Token logit bias adjustments | \{
"50256": -100
} | +| `logprobs` | *OptionalNullable[bool]* | ➖ | Return log probabilities | false | +| `max_completion_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens in completion | 100 | +| `max_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | +| `metadata` | Dict[str, *str*] | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | +| `min_p` | *OptionalNullable[float]* | ➖ | 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` | List[[components.Modality](../../components/modality.mdx)] | ➖ | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `model` | *Optional[str]* | ➖ | Model to use for completion | openai/gpt-4 | +| `models` | List[*str*] | ➖ | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | +| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../../components/chatrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `prediction` | [OptionalNullable[components.Prediction]](../../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"
} | +| `presence_penalty` | *OptionalNullable[float]* | ➖ | Presence penalty (-2.0 to 2.0) | 0 | +| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [Optional[components.ChatRequestReasoning]](../../components/chatrequestreasoning.mdx) | ➖ | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../../components/chatrequestreasoningeffort.mdx) | ➖ | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | +| `repetition_penalty` | *OptionalNullable[float]* | ➖ | 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 | +| `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.mdx) | ➖ | Response format configuration | \{
"type": "json_object"
} | +| `seed` | *OptionalNullable[int]* | ➖ | Random seed for deterministic outputs | 42 | +| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../../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 | +| `session_id` | *Optional[str]* | ➖ | 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[components.Stop]](../../components/stop.mdx) | ➖ | Stop sequences (up to 4) | [
"\n"
] | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | Enable streaming response | false | +| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.mdx) | ➖ | Streaming configuration options | \{
"include_usage": true
} | +| `temperature` | *OptionalNullable[float]* | ➖ | Sampling temperature (0-2) | 0.7 | +| `tool_choice` | [Optional[components.ChatToolChoice]](../../components/chattoolchoice.mdx) | ➖ | Tool choice configuration | auto | +| `tools` | List[[components.ChatFunctionTool](../../components/chatfunctiontool.mdx)] | ➖ | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `top_a` | *OptionalNullable[float]* | ➖ | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | +| `top_k` | *OptionalNullable[int]* | ➖ | 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 | +| `top_logprobs` | *OptionalNullable[int]* | ➖ | Number of top log probabilities to return (0-20) | 5 | +| `top_p` | *OptionalNullable[float]* | ➖ | Nucleus sampling parameter (0-1) | 1 | +| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/classifications/README.mdx b/docs/sdks/classifications/README.mdx index bed5f74e5..c59bcbd8e 100644 --- a/docs/sdks/classifications/README.mdx +++ b/docs/sdks/classifications/README.mdx @@ -58,11 +58,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `window` | [Optional[operations.Window]](../../operations/window.mdx) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `window` | [Optional[operations.Window]](../../operations/window.mdx) | ➖ | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/containers/README.mdx b/docs/sdks/containers/README.mdx index 6c21ea543..4892ff786 100644 --- a/docs/sdks/containers/README.mdx +++ b/docs/sdks/containers/README.mdx @@ -43,13 +43,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | :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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | -| `after` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `container_id` | *str* | ✅ | 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 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | +| `after` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -96,12 +96,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | :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 | -| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `container_id` | *str* | ✅ | 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 | +| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -149,12 +149,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | :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 | -| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `container_id` | *str* | ✅ | 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 | +| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -202,12 +202,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container_id` | *str* | :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 | -| `file_id` | *str* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `container_id` | *str* | ✅ | 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 | +| `file_id` | *str* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/credits/README.mdx b/docs/sdks/credits/README.mdx index 414ae2830..0af3b3eb8 100644 --- a/docs/sdks/credits/README.mdx +++ b/docs/sdks/credits/README.mdx @@ -40,10 +40,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/datasets/README.mdx b/docs/sdks/datasets/README.mdx index fe31c0f4f..d7053e23a 100644 --- a/docs/sdks/datasets/README.mdx +++ b/docs/sdks/datasets/README.mdx @@ -68,17 +68,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `category` | [Optional[operations.GetAppRankingsCategory]](../../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` | [Optional[operations.Subcategory]](../../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` | [Optional[operations.GetAppRankingsSort]](../../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 | -| `start_date` | *Optional[str]* | :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 | -| `end_date` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Maximum number of apps to return (1-100). Defaults to 50. | 50 | -| `offset` | *OptionalNullable[int]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `category` | [Optional[operations.GetAppRankingsCategory]](../../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` | [Optional[operations.Subcategory]](../../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` | [Optional[operations.GetAppRankingsSort]](../../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 | +| `start_date` | *Optional[str]* | ➖ | 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 | +| `end_date` | *Optional[str]* | ➖ | 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` | *Optional[int]* | ➖ | Maximum number of apps to return (1-100). Defaults to 50. | 50 | +| `offset` | *OptionalNullable[int]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -150,17 +150,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `start_date` | *Optional[str]* | :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 | -| `end_date` | *Optional[str]* | :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` | [Optional[operations.Period]](../../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` | [Optional[operations.Modality]](../../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 | -| `context_bucket` | [Optional[operations.ContextBucket]](../../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` | [Optional[operations.GetRankingsDailyCategory]](../../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 | -| `language_type` | [Optional[operations.LanguageType]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `start_date` | *Optional[str]* | ➖ | 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 | +| `end_date` | *Optional[str]* | ➖ | 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` | [Optional[operations.Period]](../../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` | [Optional[operations.Modality]](../../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 | +| `context_bucket` | [Optional[operations.ContextBucket]](../../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` | [Optional[operations.GetRankingsDailyCategory]](../../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 | +| `language_type` | [Optional[operations.LanguageType]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -215,15 +215,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `app_slug` | *Optional[str]* | :heavy_minus_sign: | Filter to one published harness slug. | hermes-agent | -| `model` | *Optional[str]* | :heavy_minus_sign: | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | -| `turn_range` | [Optional[operations.TurnRange]](../../operations/turnrange.mdx) | :heavy_minus_sign: | Filter by the inclusive number of turns in a session. | 10-49-turns | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of cells to return (1-500). Defaults to 100. | 100 | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `app_slug` | *Optional[str]* | ➖ | Filter to one published harness slug. | hermes-agent | +| `model` | *Optional[str]* | ➖ | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | +| `turn_range` | [Optional[operations.TurnRange]](../../operations/turnrange.mdx) | ➖ | Filter by the inclusive number of turns in a session. | 10-49-turns | +| `limit` | *Optional[int]* | ➖ | Maximum number of cells to return (1-500). Defaults to 100. | 100 | +| `offset` | *OptionalNullable[int]* | ➖ | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/decisions/README.mdx b/docs/sdks/decisions/README.mdx index 0d2c73720..10f96fd4b 100644 --- a/docs/sdks/decisions/README.mdx +++ b/docs/sdks/decisions/README.mdx @@ -70,18 +70,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `questions` | Dict[str, [components.Questions](../../components/questions.mdx)] | :heavy_check_mark: | N/A | | -| `state` | [components.State](../../components/state.mdx) | :heavy_check_mark: | The content to evaluate: a plain string, or a JSON object or array of related context. | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | :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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | -| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | +| `model` | *str* | ✅ | N/A | | +| `questions` | Dict[str, [components.Questions](../../components/questions.mdx)] | ✅ | N/A | | +| `state` | [components.State](../../components/state.mdx) | ✅ | The content to evaluate: a plain string, or a JSON object or array of related context. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | ➖ | 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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | N/A | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | +| `server_url` | *Optional[str]* | ➖ | An optional server URL to use. | http://localhost:8080 | ### Response diff --git a/docs/sdks/embeddings/README.mdx b/docs/sdks/embeddings/README.mdx index 08cfd727d..dfae39541 100644 --- a/docs/sdks/embeddings/README.mdx +++ b/docs/sdks/embeddings/README.mdx @@ -41,19 +41,19 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `input` | [operations.InputUnion](../../operations/inputunion.mdx) | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `model` | *str* | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `dimensions` | *Optional[int]* | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | -| `encoding_format` | [Optional[operations.EncodingFormat]](../../operations/encodingformat.mdx) | :heavy_minus_sign: | The format of the output embeddings | float | -| `input_type` | *Optional[str]* | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | :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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `input` | [operations.InputUnion](../../operations/inputunion.mdx) | ✅ | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | +| `model` | *str* | ✅ | The model to use for embeddings | openai/text-embedding-3-small | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `dimensions` | *Optional[int]* | ➖ | The number of dimensions for the output embeddings | 1536 | +| `encoding_format` | [Optional[operations.EncodingFormat]](../../operations/encodingformat.mdx) | ➖ | The format of the output embeddings | float | +| `input_type` | *Optional[str]* | ➖ | The type of input (e.g. search_query, search_document) | search_query | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | ➖ | 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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | A unique identifier for the end-user | user-1234 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -110,12 +110,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/endpoints/README.mdx b/docs/sdks/endpoints/README.mdx index f8cebc206..bfe6c422f 100644 --- a/docs/sdks/endpoints/README.mdx +++ b/docs/sdks/endpoints/README.mdx @@ -41,10 +41,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -87,12 +87,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | *str* | :heavy_check_mark: | The model slug | gpt-4 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `author` | *str* | ✅ | The author/organization of the model | openai | +| `slug` | *str* | ✅ | The model slug | gpt-4 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/endusers/README.mdx b/docs/sdks/endusers/README.mdx index a586a1d47..c9513be85 100644 --- a/docs/sdks/endusers/README.mdx +++ b/docs/sdks/endusers/README.mdx @@ -46,14 +46,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `user` | *Optional[str]* | :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 | -| `include_inactive` | *Optional[bool]* | :heavy_minus_sign: | Include deactivated registrations. | false | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `user` | *Optional[str]* | ➖ | 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 | +| `include_inactive` | *Optional[bool]* | ➖ | Include deactivated registrations. | false | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -98,11 +98,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | :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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `user` | *str* | ✅ | 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 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -147,11 +147,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | :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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `user` | *str* | ✅ | 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 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Errors @@ -192,11 +192,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | :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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `user` | *str* | ✅ | 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 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -241,12 +241,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `user` | *str* | :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 | -| `is_active` | *bool* | :heavy_check_mark: | Registration state only; does not enforce inference access. | true | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `user` | *str* | ✅ | 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 | +| `is_active` | *bool* | ✅ | Registration state only; does not enforce inference access. | true | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/files/README.mdx b/docs/sdks/files/README.mdx index d9aef34c1..061e84552 100644 --- a/docs/sdks/files/README.mdx +++ b/docs/sdks/files/README.mdx @@ -46,18 +46,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of files to return (1–1000). | 100 | -| `cursor` | *Optional[str]* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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` | *Optional[str]* | :heavy_minus_sign: | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `after_id` | *Optional[str]* | :heavy_minus_sign: | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `before_id` | *Optional[str]* | :heavy_minus_sign: | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `order` | [Optional[operations.Order]](../../operations/order.mdx) | :heavy_minus_sign: | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Maximum number of files to return (1–1000). | 100 | +| `cursor` | *Optional[str]* | ➖ | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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` | *Optional[str]* | ➖ | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `after_id` | *Optional[str]* | ➖ | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `before_id` | *Optional[str]* | ➖ | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `order` | [Optional[operations.Order]](../../operations/order.mdx) | ➖ | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -108,13 +108,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file` | [operations.UploadFileFile](../../operations/uploadfilefile.mdx) | :heavy_check_mark: | N/A | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `file` | [operations.UploadFileFile](../../operations/uploadfilefile.mdx) | ✅ | N/A | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -163,13 +163,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -217,13 +217,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -271,13 +271,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [Optional[components.FileProvider]](../../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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `file_id` | *str* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspace_id` | *Optional[str]* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [Optional[components.FileProvider]](../../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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/generations/README.mdx b/docs/sdks/generations/README.mdx index bc1a56cbb..65c5e926d 100644 --- a/docs/sdks/generations/README.mdx +++ b/docs/sdks/generations/README.mdx @@ -42,11 +42,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The generation ID | gen-1234567890 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -96,11 +96,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The generation ID | gen-1234567890 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -150,13 +150,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `category` | [components.SubmitGenerationFeedbackRequestCategory](../../components/submitgenerationfeedbackrequestcategory.mdx) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | -| `generation_id` | *str* | :heavy_check_mark: | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `comment` | *Optional[str]* | :heavy_minus_sign: | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `category` | [components.SubmitGenerationFeedbackRequestCategory](../../components/submitgenerationfeedbackrequestcategory.mdx) | ✅ | The category of feedback being reported | incorrect_response | +| `generation_id` | *str* | ✅ | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `comment` | *Optional[str]* | ➖ | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/guardrails/README.mdx b/docs/sdks/guardrails/README.mdx index 6fbf9985e..7935369ff 100644 --- a/docs/sdks/guardrails/README.mdx +++ b/docs/sdks/guardrails/README.mdx @@ -54,13 +54,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | ➖ | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -110,33 +110,33 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | true | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../../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"
] | -| `allowed_models` | List[*str*] | :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"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../../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[str]* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | -| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| `enforce_zdr` | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *OptionalNullable[float]* | :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 | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../../components/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `workspace_id` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | ✅ | Name for the new guardrail | My New Guardrail | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `allow_safety_retention_google` | *OptionalNullable[bool]* | ➖ | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | true | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../../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"
] | +| `allowed_models` | List[*str*] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | +| `allowed_providers` | List[*str*] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../../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[str]* | ➖ | Description of the guardrail | A guardrail for limiting API usage | +| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| `enforce_zdr` | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `ignored_models` | List[*str*] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *OptionalNullable[float]* | ➖ | 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 | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `workspace_id` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -181,11 +181,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -229,11 +229,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -277,33 +277,33 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allow_safety_retention_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | false | -| `allowed_data_regions` | List[[components.GuardrailDataRegion](../../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"
] | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../../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"
}
] | -| `content_filters` | List[[components.ContentFilterEntry](../../components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the guardrail | Updated description | -| `enable_free_model_publication` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enable_free_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `enable_paid_model_training` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| `enforce_zdr` | *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 | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_other` | *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 | -| `enforce_zdr_xai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `include_byok_in_budgets` | *Optional[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 | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit in USD | 75 | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../../components/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `allow_safety_retention_google` | *OptionalNullable[bool]* | ➖ | Whether ZDR-only requests to google/* models may use endpoints that may retain prompts for safety monitoring. false allows only zero-retention endpoints. A guardrail can only be more restrictive than the account setting. Inherits the account setting when not provided. | false | +| `allowed_data_regions` | List[[components.GuardrailDataRegion](../../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"
] | +| `allowed_models` | List[*str*] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | +| `allowed_providers` | List[*str*] | ➖ | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](../../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"
}
] | +| `content_filters` | List[[components.ContentFilterEntry](../../components/contentfilterentry.mdx)] | ➖ | Custom regex content filters to apply. Set to null to remove. | null | +| `description` | *OptionalNullable[str]* | ➖ | New description for the guardrail | Updated description | +| `enable_free_model_publication` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enable_free_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `enable_paid_model_training` | *OptionalNullable[bool]* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| `enforce_zdr` | *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 | +| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_google` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_openai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | +| `enforce_zdr_other` | *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 | +| `enforce_zdr_xai` | *OptionalNullable[bool]* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | +| `ignored_models` | List[*str*] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignored_providers` | List[*str*] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `include_byok_in_budgets` | *Optional[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 | +| `limit_usd` | *OptionalNullable[float]* | ➖ | New spending limit in USD | 75 | +| `name` | *Optional[str]* | ➖ | New name for the guardrail | Updated Guardrail Name | +| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../../components/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -352,13 +352,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -404,12 +404,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `key_hashes` | List[*str*] | ✅ | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -457,12 +457,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `key_hashes` | List[*str*] | ✅ | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -509,13 +509,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -562,12 +562,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `member_user_ids` | List[*str*] | ✅ | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -615,12 +615,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `member_user_ids` | List[*str*] | ✅ | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -667,12 +667,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -717,12 +717,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/images/README.mdx b/docs/sdks/images/README.mdx index 08c687694..8cb4e9e20 100644 --- a/docs/sdks/images/README.mdx +++ b/docs/sdks/images/README.mdx @@ -44,27 +44,27 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `model` | *str* | :heavy_check_mark: | The image generation model to use | bytedance-seed/seedream-4.5 | -| `prompt` | *str* | :heavy_check_mark: | Text description of the desired image | a red panda astronaut floating in space, studio lighting | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `aspect_ratio` | [Optional[components.ImageGenerationRequestAspectRatio]](../../components/imagegenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | -| `background` | [Optional[components.ImageGenerationRequestBackground]](../../components/imagegenerationrequestbackground.mdx) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | -| `input_references` | List[[components.ContentPartImage](../../components/contentpartimage.mdx)] | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | -| `n` | *Optional[int]* | :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 | -| `output_compression` | *Optional[int]* | :heavy_minus_sign: | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | -| `output_format` | [Optional[components.ImageGenerationRequestOutputFormat]](../../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 | -| `provider` | [Optional[components.ImageGenerationProviderPreferences]](../../components/imagegenerationproviderpreferences.mdx) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | -| `quality` | [Optional[components.ImageGenerationRequestQuality]](../../components/imagegenerationrequestquality.mdx) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | -| `resolution` | [Optional[components.ImageGenerationRequestResolution]](../../components/imagegenerationrequestresolution.mdx) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | -| `seed` | *Optional[int]* | :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. | | -| `session_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | *Optional[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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `model` | *str* | ✅ | The image generation model to use | bytedance-seed/seedream-4.5 | +| `prompt` | *str* | ✅ | Text description of the desired image | a red panda astronaut floating in space, studio lighting | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `aspect_ratio` | [Optional[components.ImageGenerationRequestAspectRatio]](../../components/imagegenerationrequestaspectratio.mdx) | ➖ | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | +| `background` | [Optional[components.ImageGenerationRequestBackground]](../../components/imagegenerationrequestbackground.mdx) | ➖ | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | +| `input_references` | List[[components.ContentPartImage](../../components/contentpartimage.mdx)] | ➖ | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | +| `n` | *Optional[int]* | ➖ | 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 | +| `output_compression` | *Optional[int]* | ➖ | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | +| `output_format` | [Optional[components.ImageGenerationRequestOutputFormat]](../../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 | +| `provider` | [Optional[components.ImageGenerationProviderPreferences]](../../components/imagegenerationproviderpreferences.mdx) | ➖ | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | +| `quality` | [Optional[components.ImageGenerationRequestQuality]](../../components/imagegenerationrequestquality.mdx) | ➖ | Rendering quality. Providers without a quality knob ignore this. | high | +| `resolution` | [Optional[components.ImageGenerationRequestResolution]](../../components/imagegenerationrequestresolution.mdx) | ➖ | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | +| `seed` | *Optional[int]* | ➖ | 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. | | +| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | *Optional[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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -116,10 +116,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -161,12 +161,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `author` | *str* | :heavy_check_mark: | Model author/organization | bytedance-seed | -| `slug` | *str* | :heavy_check_mark: | Model slug | seedream-4.5 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `author` | *str* | ✅ | Model author/organization | bytedance-seed | +| `slug` | *str* | ✅ | Model slug | seedream-4.5 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/interns/README.mdx b/docs/sdks/interns/README.mdx index b90fc698b..a7bd746bb 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 * [get_intern](#get_intern) - Get an intern * [update_intern](#update_intern) - Update an intern * [get_intern_daemon](#get_intern_daemon) - Get an intern's daemon access -* [~~get_intern_daemon_access~~](#get_intern_daemon_access) - Get an intern's daemon access (deprecated alias) :warning: **Deprecated** -* [~~sign_intern_daemon_access_request~~](#sign_intern_daemon_access_request) - Sign a daemon request with the caller's identity (deprecated alias) :warning: **Deprecated** +* [~~get_intern_daemon_access~~](#get_intern_daemon_access) - Get an intern's daemon access (deprecated alias) ⚠️ **Deprecated** +* [~~sign_intern_daemon_access_request~~](#sign_intern_daemon_access_request) - Sign a daemon request with the caller's identity (deprecated alias) ⚠️ **Deprecated** * [sign_intern_daemon_request](#sign_intern_daemon_request) - Sign a daemon request with the caller's identity * [provision_intern](#provision_intern) - Provision an intern * [suspend_intern](#suspend_intern) - Suspend an intern @@ -52,14 +52,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of interns to return, from 1 through 500. | 50 | -| `status` | List[[operations.Status](../../operations/status.mdx)] | :heavy_minus_sign: | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | -| `starting_after` | *Optional[str]* | :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 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Maximum number of interns to return, from 1 through 500. | 50 | +| `status` | List[[operations.Status](../../operations/status.mdx)] | ➖ | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | +| `starting_after` | *Optional[str]* | ➖ | 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 | +| `workspace_id` | *Optional[str]* | ➖ | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -102,17 +102,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Intern name, unique per creator within the workspace. | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotency_key` | *Optional[str]* | :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 | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Free-form description, or null. | | -| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | Standing instructions the intern boots with, or null. | | -| `provision` | *Optional[bool]* | :heavy_minus_sign: | Start provisioning during this create operation. Defaults to false. | | -| `vault_id` | *Optional[str]* | :heavy_minus_sign: | Vault owned by another intern in this workspace to attach as a borrowed vault. | | -| `workspace_id` | *Optional[str]* | :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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | ✅ | Intern name, unique per creator within the workspace. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotency_key` | *Optional[str]* | ➖ | 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 | +| `description` | *OptionalNullable[str]* | ➖ | Free-form description, or null. | | +| `instructions` | *OptionalNullable[str]* | ➖ | Standing instructions the intern boots with, or null. | | +| `provision` | *Optional[bool]* | ➖ | Start provisioning during this create operation. Defaults to false. | | +| `vault_id` | *Optional[str]* | ➖ | Vault owned by another intern in this workspace to attach as a borrowed vault. | | +| `workspace_id` | *Optional[str]* | ➖ | Workspace that will own the intern. Defaults to the workspace the API key resolves to. When given, it must match the API key workspace. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -155,12 +155,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `acknowledge_workspace_loss` | *Optional[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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `acknowledge_workspace_loss` | *Optional[bool]* | ➖ | Delete even though the workspace backup was not confirmed. Defaults to false, which refuses the teardown when a workspace archive is missing. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -203,11 +203,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -250,15 +250,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New free-form description. Null clears it. | | -| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | New standing instructions. Null clears them. | | -| `model` | *OptionalNullable[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | New intern name, unique per creator within the workspace. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `description` | *OptionalNullable[str]* | ➖ | New free-form description. Null clears it. | | +| `instructions` | *OptionalNullable[str]* | ➖ | New standing instructions. Null clears them. | | +| `model` | *OptionalNullable[str]* | ➖ | 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` | *Optional[str]* | ➖ | New intern name, unique per creator within the workspace. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -301,11 +301,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -323,7 +323,7 @@ with OpenRouter( 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 @@ -350,11 +350,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -372,7 +372,7 @@ with OpenRouter( 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 @@ -399,12 +399,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `body_sha256` | *str* | :heavy_check_mark: | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `body_sha256` | *str* | ✅ | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -448,12 +448,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `body_sha256` | *str* | :heavy_check_mark: | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `body_sha256` | *str* | ✅ | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -497,11 +497,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -544,11 +544,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -610,15 +610,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | -| `messages` | List[[components.InternChatMessage](../../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`. | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `approval_mode` | [Optional[components.InternApprovalMode]](../../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 | -| `model` | *Optional[str]* | :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 | -| `session_id` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | +| `messages` | List[[components.InternChatMessage](../../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`. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `approval_mode` | [Optional[components.InternApprovalMode]](../../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 | +| `model` | *Optional[str]* | ➖ | 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 | +| `session_id` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -669,13 +669,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | The intern to run. | a11e0000-0000-4000-8000-000000000005 | -| `input` | *str* | :heavy_check_mark: | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `session_id` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | The intern to run. | a11e0000-0000-4000-8000-000000000005 | +| `input` | *str* | ✅ | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `session_id` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/models/README.mdx b/docs/sdks/models/README.mdx index 9131aee97..ad099b012 100644 --- a/docs/sdks/models/README.mdx +++ b/docs/sdks/models/README.mdx @@ -43,12 +43,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | *str* | :heavy_check_mark: | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `author` | *str* | ✅ | The author/organization of the model | openai | +| `slug` | *str* | ✅ | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -94,39 +94,39 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | :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` | [Optional[operations.GetModelsCategory]](../../operations/getmodelscategory.mdx) | :heavy_minus_sign: | Filter models by use case category | programming | -| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | -| `output_modalities` | *Optional[str]* | :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` | [Optional[operations.GetModelsSort]](../../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` | *Optional[str]* | :heavy_minus_sign: | Free-text search by model name or slug. | gpt-4 | -| `input_modalities` | *Optional[str]* | :heavy_minus_sign: | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | -| `context` | *Optional[int]* | :heavy_minus_sign: | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | -| `min_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum prompt price in $/M tokens. | 0 | -| `max_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum prompt price in $/M tokens. | 10 | -| `arch` | *Optional[str]* | :heavy_minus_sign: | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | -| `model_authors` | *Optional[str]* | :heavy_minus_sign: | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | -| `providers` | *Optional[str]* | :heavy_minus_sign: | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | -| `distillable` | [Optional[operations.Distillable]](../../operations/distillable.mdx) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | -| `zdr` | [Optional[operations.Zdr]](../../operations/zdr.mdx) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | -| `region` | [Optional[operations.Region]](../../operations/region.mdx) | :heavy_minus_sign: | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | -| `min_output_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum completion (output) price in $/M tokens. | 0 | -| `max_output_price` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum completion (output) price in $/M tokens. | 10 | -| `min_age_days` | *OptionalNullable[int]* | :heavy_minus_sign: | Minimum model age in days since its creation date. | 0 | -| `max_age_days` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum model age in days since its creation date. | 90 | -| `min_intelligence_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis intelligence index. | 50 | -| `max_intelligence_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis intelligence index. | 100 | -| `min_coding_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis coding index. | 50 | -| `max_coding_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis coding index. | 100 | -| `min_agentic_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum Artificial Analysis agentic index. | 50 | -| `max_agentic_index` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum Artificial Analysis agentic index. | 100 | -| `min_tool_success_rate` | *OptionalNullable[float]* | :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 | -| `max_tool_success_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `category` | [Optional[operations.GetModelsCategory]](../../operations/getmodelscategory.mdx) | ➖ | Filter models by use case category | programming | +| `supported_parameters` | *Optional[str]* | ➖ | Filter models by supported parameter (comma-separated) | temperature | +| `output_modalities` | *Optional[str]* | ➖ | 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` | [Optional[operations.GetModelsSort]](../../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` | *Optional[str]* | ➖ | Free-text search by model name or slug. | gpt-4 | +| `input_modalities` | *Optional[str]* | ➖ | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | +| `context` | *Optional[int]* | ➖ | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | +| `min_price` | *OptionalNullable[float]* | ➖ | Minimum prompt price in $/M tokens. | 0 | +| `max_price` | *OptionalNullable[float]* | ➖ | Maximum prompt price in $/M tokens. | 10 | +| `arch` | *Optional[str]* | ➖ | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | +| `model_authors` | *Optional[str]* | ➖ | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | +| `providers` | *Optional[str]* | ➖ | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | +| `distillable` | [Optional[operations.Distillable]](../../operations/distillable.mdx) | ➖ | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | +| `zdr` | [Optional[operations.Zdr]](../../operations/zdr.mdx) | ➖ | When set to "true", return only models with zero data retention endpoints. | true | +| `region` | [Optional[operations.Region]](../../operations/region.mdx) | ➖ | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | +| `min_output_price` | *OptionalNullable[float]* | ➖ | Minimum completion (output) price in $/M tokens. | 0 | +| `max_output_price` | *OptionalNullable[float]* | ➖ | Maximum completion (output) price in $/M tokens. | 10 | +| `min_age_days` | *OptionalNullable[int]* | ➖ | Minimum model age in days since its creation date. | 0 | +| `max_age_days` | *OptionalNullable[int]* | ➖ | Maximum model age in days since its creation date. | 90 | +| `min_intelligence_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis intelligence index. | 50 | +| `max_intelligence_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis intelligence index. | 100 | +| `min_coding_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis coding index. | 50 | +| `max_coding_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis coding index. | 100 | +| `min_agentic_index` | *OptionalNullable[float]* | ➖ | Minimum Artificial Analysis agentic index. | 50 | +| `max_agentic_index` | *OptionalNullable[float]* | ➖ | Maximum Artificial Analysis agentic index. | 100 | +| `min_tool_success_rate` | *OptionalNullable[float]* | ➖ | 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 | +| `max_tool_success_rate` | *OptionalNullable[float]* | ➖ | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -170,11 +170,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `output_modalities` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `output_modalities` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -221,14 +221,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `security` | [operations.ListModelsUserSecurity](../../operations/listmodelsusersecurity.mdx) | :heavy_check_mark: | N/A | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `output_modalities` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `security` | [operations.ListModelsUserSecurity](../../operations/listmodelsusersecurity.mdx) | ✅ | N/A | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `output_modalities` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/oauth/README.mdx b/docs/sdks/oauth/README.mdx index ac1d96c85..50b9f0224 100644 --- a/docs/sdks/oauth/README.mdx +++ b/docs/sdks/oauth/README.mdx @@ -43,13 +43,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *str* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../../operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `code_verifier` | *Optional[str]* | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `code` | *str* | ✅ | The authorization code received from the OAuth redirect | auth_code_abc123def456 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../../operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | +| `code_verifier` | *Optional[str]* | ➖ | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -93,18 +93,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `callback_url` | *str* | :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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `code_challenge` | *Optional[str]* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../../operations/createauthkeyscodecodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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 | -| `key_label` | *Optional[str]* | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | -| `limit` | *Optional[float]* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `usage_limit_type` | [Optional[operations.UsageLimitType]](../../operations/usagelimittype.mdx) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to associate the API key with | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `callback_url` | *str* | ✅ | 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 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `code_challenge` | *Optional[str]* | ➖ | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | +| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../../operations/createauthkeyscodecodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | +| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | ➖ | 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 | +| `key_label` | *Optional[str]* | ➖ | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | +| `limit` | *Optional[float]* | ➖ | Credit limit for the API key to be created | 100 | +| `usage_limit_type` | [Optional[operations.UsageLimitType]](../../operations/usagelimittype.mdx) | ➖ | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | +| `workspace_id` | *Optional[str]* | ➖ | Optional workspace ID to associate the API key with | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -150,10 +150,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -195,16 +195,16 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `federation_policy_id` | *str* | :heavy_check_mark: | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | -| `grant_type` | [components.GrantType](../../components/granttype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | -| `subject_token` | *str* | :heavy_check_mark: | The JWT issued by your identity provider. | \ | -| `subject_token_type` | [components.SubjectTokenType](../../components/subjecttokentype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requested_token_type` | [Optional[components.RequestedTokenType]](../../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` | [Optional[components.TokenExchangeRequestScope]](../../components/tokenexchangerequestscope.mdx) | :heavy_minus_sign: | Optional; only `inference` is available. | inference | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `federation_policy_id` | *str* | ✅ | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | +| `grant_type` | [components.GrantType](../../components/granttype.mdx) | ✅ | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | +| `subject_token` | *str* | ✅ | The JWT issued by your identity provider. | \ | +| `subject_token_type` | [components.SubjectTokenType](../../components/subjecttokentype.mdx) | ✅ | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `requested_token_type` | [Optional[components.RequestedTokenType]](../../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` | [Optional[components.TokenExchangeRequestScope]](../../components/tokenexchangerequestscope.mdx) | ➖ | Optional; only `inference` is available. | inference | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/observability/README.mdx b/docs/sdks/observability/README.mdx index b87e2e382..ee483a418 100644 --- a/docs/sdks/observability/README.mdx +++ b/docs/sdks/observability/README.mdx @@ -46,13 +46,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspace_id` | *Optional[str]* | ➖ | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -100,24 +100,24 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `config` | Dict[str, *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"
} | -| `name` | *str* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `type` | [components.CreateObservabilityDestinationRequestType](../../components/createobservabilitydestinationrequesttype.mdx) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *Optional[bool]* | :heavy_minus_sign: | When true, include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *Optional[bool]* | :heavy_minus_sign: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *Optional[bool]* | :heavy_minus_sign: | When true, include identity generation metadata. | false | -| `broadcast_generation_request_context` | *Optional[bool]* | :heavy_minus_sign: | When true, include request-context generation metadata. | false | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../../components/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | -| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegionInput](../../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"
] | -| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `config` | Dict[str, *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"
} | +| `name` | *str* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `type` | [components.CreateObservabilityDestinationRequestType](../../components/createobservabilitydestinationrequesttype.mdx) | ✅ | The destination type. Only stable destination types are accepted. | langfuse | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `api_key_hashes` | List[*str*] | ➖ | 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 | +| `broadcast_generation_cost` | *Optional[bool]* | ➖ | When true, include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *Optional[bool]* | ➖ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *Optional[bool]* | ➖ | When true, include identity generation metadata. | false | +| `broadcast_generation_request_context` | *Optional[bool]* | ➖ | When true, include request-context generation metadata. | false | +| `enabled` | *Optional[bool]* | ➖ | Whether this destination should be enabled immediately. | true | +| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../../components/observabilityfilterrulesconfignullable.mdx) | ➖ | Optional structured filter rules controlling which events are forwarded. | null | +| `privacy_mode` | *Optional[bool]* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegionInput](../../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"
] | +| `sampling_rate` | *Optional[float]* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | +| `workspace_id` | *Optional[str]* | ➖ | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -163,11 +163,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -211,11 +211,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -259,23 +259,23 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `api_key_hashes` | List[*str*] | :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 | -| `broadcast_generation_cost` | *Optional[bool]* | :heavy_minus_sign: | Whether to include cost and billing generation metadata. | false | -| `broadcast_generation_cost_allocation` | *Optional[bool]* | :heavy_minus_sign: | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | -| `broadcast_generation_identity` | *Optional[bool]* | :heavy_minus_sign: | Whether to include identity generation metadata. | false | -| `broadcast_generation_request_context` | *Optional[bool]* | :heavy_minus_sign: | Whether to include request-context generation metadata. | false | -| `config` | Dict[str, *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` | *Optional[bool]* | :heavy_minus_sign: | Whether the destination is enabled. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../../components/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | N/A | null | -| `name` | *Optional[str]* | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | List[[components.ObservabilityDataRegionInput](../../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"
] | -| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `api_key_hashes` | List[*str*] | ➖ | 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 | +| `broadcast_generation_cost` | *Optional[bool]* | ➖ | Whether to include cost and billing generation metadata. | false | +| `broadcast_generation_cost_allocation` | *Optional[bool]* | ➖ | Beta. When true, include openrouter_cost_allocation: per-token-kind usage and cost, sent only when they reconcile with the billed cost. | false | +| `broadcast_generation_identity` | *Optional[bool]* | ➖ | Whether to include identity generation metadata. | false | +| `broadcast_generation_request_context` | *Optional[bool]* | ➖ | Whether to include request-context generation metadata. | false | +| `config` | Dict[str, *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` | *Optional[bool]* | ➖ | Whether the destination is enabled. | true | +| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfigNullable]](../../components/observabilityfilterrulesconfignullable.mdx) | ➖ | N/A | null | +| `name` | *Optional[str]* | ➖ | Human-readable name for the destination. | Production Langfuse | +| `privacy_mode` | *Optional[bool]* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | List[[components.ObservabilityDataRegionInput](../../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"
] | +| `sampling_rate` | *Optional[float]* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/organization/README.mdx b/docs/sdks/organization/README.mdx index c39c54c9f..6ab988db6 100644 --- a/docs/sdks/organization/README.mdx +++ b/docs/sdks/organization/README.mdx @@ -44,12 +44,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -93,10 +93,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -140,11 +140,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `is_filtered_model_catalog_enabled` | *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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `is_filtered_model_catalog_enabled` | *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 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/presets/README.mdx b/docs/sdks/presets/README.mdx index a13fecc06..9d209f102 100644 --- a/docs/sdks/presets/README.mdx +++ b/docs/sdks/presets/README.mdx @@ -48,12 +48,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -97,11 +97,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -155,53 +155,53 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messages` | List[[components.ChatMessages](../../components/chatmessages.mdx)] | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `image_config` | Dict[str, [components.ImageConfig](../../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"
} | -| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | -| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | -| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | -| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `metadata` | Dict[str, *str*] | :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"
} | -| `min_p` | *OptionalNullable[float]* | :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` | List[[components.Modality](../../components/modality.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | -| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../../components/chatrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `prediction` | [OptionalNullable[components.Prediction]](../../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"
} | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [Optional[components.ChatRequestReasoning]](../../components/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../../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 | -| `repetition_penalty` | *OptionalNullable[float]* | :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 | -| `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.mdx) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | -| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../../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 | -| `session_id` | *Optional[str]* | :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[components.Stop]](../../components/stop.mdx) | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.mdx) | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `tool_choice` | [Optional[components.ChatToolChoice]](../../components/chattoolchoice.mdx) | :heavy_minus_sign: | Tool choice configuration | auto | -| `tools` | List[[components.ChatFunctionTool](../../components/chatfunctiontool.mdx)] | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | -| `top_a` | *OptionalNullable[float]* | :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 | -| `top_k` | *OptionalNullable[int]* | :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 | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `messages` | List[[components.ChatMessages](../../components/chatmessages.mdx)] | ✅ | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | ➖ | Frequency penalty (-2.0 to 2.0) | 0 | +| `image_config` | Dict[str, [components.ImageConfig](../../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"
} | +| `logit_bias` | Dict[str, *float*] | ➖ | Token logit bias adjustments | \{
"50256": -100
} | +| `logprobs` | *OptionalNullable[bool]* | ➖ | Return log probabilities | false | +| `max_completion_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens in completion | 100 | +| `max_tokens` | *OptionalNullable[int]* | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | +| `metadata` | Dict[str, *str*] | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | +| `min_p` | *OptionalNullable[float]* | ➖ | 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` | List[[components.Modality](../../components/modality.mdx)] | ➖ | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `model` | *Optional[str]* | ➖ | Model to use for completion | openai/gpt-4 | +| `models` | List[*str*] | ➖ | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | +| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](../../components/chatrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `prediction` | [OptionalNullable[components.Prediction]](../../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"
} | +| `presence_penalty` | *OptionalNullable[float]* | ➖ | Presence penalty (-2.0 to 2.0) | 0 | +| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [Optional[components.ChatRequestReasoning]](../../components/chatrequestreasoning.mdx) | ➖ | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `reasoning_effort` | [OptionalNullable[components.ChatRequestReasoningEffort]](../../components/chatrequestreasoningeffort.mdx) | ➖ | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | +| `repetition_penalty` | *OptionalNullable[float]* | ➖ | 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 | +| `response_format` | [Optional[components.ResponseFormat]](../../components/responseformat.mdx) | ➖ | Response format configuration | \{
"type": "json_object"
} | +| `seed` | *OptionalNullable[int]* | ➖ | Random seed for deterministic outputs | 42 | +| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../../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 | +| `session_id` | *Optional[str]* | ➖ | 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[components.Stop]](../../components/stop.mdx) | ➖ | Stop sequences (up to 4) | [
"\n"
] | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | Enable streaming response | false | +| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../../components/chatstreamoptions.mdx) | ➖ | Streaming configuration options | \{
"include_usage": true
} | +| `temperature` | *OptionalNullable[float]* | ➖ | Sampling temperature (0-2) | 0.7 | +| `tool_choice` | [Optional[components.ChatToolChoice]](../../components/chattoolchoice.mdx) | ➖ | Tool choice configuration | auto | +| `tools` | List[[components.ChatFunctionTool](../../components/chatfunctiontool.mdx)] | ➖ | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `top_a` | *OptionalNullable[float]* | ➖ | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | +| `top_k` | *OptionalNullable[int]* | ➖ | 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 | +| `top_logprobs` | *OptionalNullable[int]* | ➖ | Number of top log probabilities to return (0-20) | 5 | +| `top_p` | *OptionalNullable[float]* | ➖ | Nucleus sampling parameter (0-1) | 1 | +| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -253,39 +253,39 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messages` | List[[components.MessagesMessageParam](../../components/messagesmessageparam.mdx)] | :heavy_check_mark: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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"
} | -| `context_management` | [OptionalNullable[components.ContextManagement]](../../components/contextmanagement.mdx) | :heavy_minus_sign: | N/A | | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `fallbacks` | List[[components.MessagesFallbackParam](../../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"
}
] | -| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `metadata` | [Optional[components.MessagesRequestMetadata]](../../components/messagesrequestmetadata.mdx) | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `output_config` | [Optional[components.MessagesOutputConfig]](../../components/messagesoutputconfig.mdx) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | -| `plugins` | List[[components.MessagesRequestPlugin](../../components/messagesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `safeguards` | List[[components.AnthropicSafeguard](../../components/anthropicsafeguard.mdx)] | :heavy_minus_sign: | N/A | | -| `service_tier` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `session_id` | *Optional[str]* | :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[components.Speed]](../../components/speed.mdx) | :heavy_minus_sign: | N/A | fast | -| `stop_sequences` | List[*str*] | :heavy_minus_sign: | N/A | | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `system` | [Optional[components.System]](../../components/system.mdx) | :heavy_minus_sign: | N/A | | -| `temperature` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `thinking` | [Optional[components.Thinking]](../../components/thinking.mdx) | :heavy_minus_sign: | N/A | | -| `tool_choice` | [Optional[components.ToolChoice]](../../components/toolchoice.mdx) | :heavy_minus_sign: | N/A | | -| `tools` | List[[components.MessagesRequestToolUnion](../../components/messagesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `messages` | List[[components.MessagesMessageParam](../../components/messagesmessageparam.mdx)] | ✅ | N/A | | +| `model` | *str* | ✅ | N/A | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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"
} | +| `context_management` | [OptionalNullable[components.ContextManagement]](../../components/contextmanagement.mdx) | ➖ | N/A | | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `fallbacks` | List[[components.MessagesFallbackParam](../../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"
}
] | +| `max_tokens` | *Optional[int]* | ➖ | N/A | | +| `metadata` | [Optional[components.MessagesRequestMetadata]](../../components/messagesrequestmetadata.mdx) | ➖ | N/A | | +| `models` | List[*str*] | ➖ | N/A | | +| `output_config` | [Optional[components.MessagesOutputConfig]](../../components/messagesoutputconfig.mdx) | ➖ | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | +| `plugins` | List[[components.MessagesRequestPlugin](../../components/messagesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `safeguards` | List[[components.AnthropicSafeguard](../../components/anthropicsafeguard.mdx)] | ➖ | N/A | | +| `service_tier` | *Optional[str]* | ➖ | N/A | | +| `session_id` | *Optional[str]* | ➖ | 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[components.Speed]](../../components/speed.mdx) | ➖ | N/A | fast | +| `stop_sequences` | List[*str*] | ➖ | N/A | | +| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | N/A | | +| `system` | [Optional[components.System]](../../components/system.mdx) | ➖ | N/A | | +| `temperature` | *Optional[float]* | ➖ | N/A | | +| `thinking` | [Optional[components.Thinking]](../../components/thinking.mdx) | ➖ | N/A | | +| `tool_choice` | [Optional[components.ToolChoice]](../../components/toolchoice.mdx) | ➖ | N/A | | +| `tools` | List[[components.MessagesRequestToolUnion](../../components/messagesrequesttoolunion.mdx)] | ➖ | N/A | | +| `top_k` | *Optional[int]* | ➖ | N/A | | +| `top_p` | *Optional[float]* | ➖ | N/A | | +| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -332,50 +332,50 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | -| `input` | [Optional[components.InputsUnion]](../../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[str]* | :heavy_minus_sign: | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :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` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | :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 | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | -| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | -| `user` | *Optional[str]* | :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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `background` | *OptionalNullable[bool]* | ➖ | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | | +| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | ➖ | N/A | | +| `input` | [Optional[components.InputsUnion]](../../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[str]* | ➖ | N/A | | +| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | ➖ | 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` | Dict[str, *str*] | ➖ | 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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `model` | *Optional[str]* | ➖ | N/A | | +| `models` | List[*str*] | ➖ | N/A | | +| `parallel_tool_calls` | *OptionalNullable[bool]* | ➖ | N/A | | +| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | | +| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | ➖ | 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 | +| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | +| `session_id` | *Optional[str]* | ➖ | 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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | N/A | | +| `temperature` | *OptionalNullable[float]* | ➖ | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | +| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | ➖ | N/A | | +| `top_k` | *Optional[int]* | ➖ | N/A | | +| `top_logprobs` | *OptionalNullable[int]* | ➖ | N/A | | +| `top_p` | *OptionalNullable[float]* | ➖ | N/A | | +| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | ➖ | N/A | auto | +| `user` | *Optional[str]* | ➖ | 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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -424,13 +424,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -475,12 +475,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `version` | *str* | :heavy_check_mark: | Version number of the preset. | 1 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `slug` | *str* | ✅ | URL-safe slug identifying the preset. | my-preset | +| `version` | *str* | ✅ | Version number of the preset. | 1 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/privateendpoints/README.mdx b/docs/sdks/privateendpoints/README.mdx index a0cd92faa..c36065eb1 100644 --- a/docs/sdks/privateendpoints/README.mdx +++ b/docs/sdks/privateendpoints/README.mdx @@ -49,10 +49,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -97,19 +97,19 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model_permaslug` | *str* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `provider_slug` | *str* | :heavy_check_mark: | Slug of the upstream provider. | azure | -| `upstream_model_id` | *str* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotency_key` | *Optional[str]* | :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 | -| `activate` | [Optional[components.PrivateEndpointActivation]](../../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"
} | -| `base_url` | *Optional[str]* | :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 | -| `declared_region` | [OptionalNullable[components.CreatePrivateEndpointRequestDeclaredRegion]](../../components/createprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | -| `declared_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | -| `pricing` | [Optional[components.PrivateEndpointPricing]](../../components/privateendpointpricing.mdx) | :heavy_minus_sign: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `model_permaslug` | *str* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `provider_slug` | *str* | ✅ | Slug of the upstream provider. | azure | +| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotency_key` | *Optional[str]* | ➖ | 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 | +| `activate` | [Optional[components.PrivateEndpointActivation]](../../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"
} | +| `base_url` | *Optional[str]* | ➖ | 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 | +| `declared_region` | [OptionalNullable[components.CreatePrivateEndpointRequestDeclaredRegion]](../../components/createprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | +| `declared_zdr` | *OptionalNullable[bool]* | ➖ | Attest that this deployment retains no prompt or completion data. | | +| `pricing` | [Optional[components.PrivateEndpointPricing]](../../components/privateendpointpricing.mdx) | ➖ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -164,12 +164,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `draft_only` | [Optional[operations.DraftOnly]](../../operations/draftonly.mdx) | :heavy_minus_sign: | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `draft_only` | [Optional[operations.DraftOnly]](../../operations/draftonly.mdx) | ➖ | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -219,11 +219,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -269,15 +269,15 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `upstream_model_id` | *str* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `base_url` | *Optional[str]* | :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 | -| `declared_region` | [OptionalNullable[components.UpdatePrivateEndpointRequestDeclaredRegion]](../../components/updateprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | -| `declared_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `upstream_model_id` | *str* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `base_url` | *Optional[str]* | ➖ | 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 | +| `declared_region` | [OptionalNullable[components.UpdatePrivateEndpointRequestDeclaredRegion]](../../components/updateprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | +| `declared_zdr` | *OptionalNullable[bool]* | ➖ | Attest that this deployment retains no prompt or completion data. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -327,11 +327,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -381,11 +381,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -435,11 +435,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -492,12 +492,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `pricing` | [components.PrivateEndpointPricing](../../components/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `pricing` | [components.PrivateEndpointPricing](../../components/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -547,12 +547,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `workspace_id` | *str* | :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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `workspace_id` | *str* | ✅ | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/providers/README.mdx b/docs/sdks/providers/README.mdx index 7571e2581..fbd074b61 100644 --- a/docs/sdks/providers/README.mdx +++ b/docs/sdks/providers/README.mdx @@ -40,10 +40,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/rerank/README.mdx b/docs/sdks/rerank/README.mdx index 0836d633a..fe71c14df 100644 --- a/docs/sdks/rerank/README.mdx +++ b/docs/sdks/rerank/README.mdx @@ -43,18 +43,18 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `documents` | List[[operations.Document](../../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` | *str* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | -| `query` | *str* | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | :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 | -| `top_n` | *Optional[int]* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | -| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `documents` | List[[operations.Document](../../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` | *str* | ✅ | The rerank model to use | cohere/rerank-v3.5 | +| `query` | *str* | ✅ | The search query to rerank documents against | What is the capital of France? | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | ➖ | 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 | +| `top_n` | *Optional[int]* | ➖ | Number of most relevant documents to return | 3 | +| `trace` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/responses/README.mdx b/docs/sdks/responses/README.mdx index ffa211962..cea72b0cf 100644 --- a/docs/sdks/responses/README.mdx +++ b/docs/sdks/responses/README.mdx @@ -64,50 +64,50 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | :heavy_minus_sign: | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | -| `input` | [Optional[components.InputsUnion]](../../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[str]* | :heavy_minus_sign: | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :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` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `safety_identifier` | *OptionalNullable[str]* | :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 | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | -| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | -| `user` | *Optional[str]* | :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. | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `x_open_router_metadata` | [Optional[components.MetadataLevel]](../../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 | +| `background` | *OptionalNullable[bool]* | ➖ | N/A | | +| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../../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` | [Optional[components.ChatDebugOptions]](../../components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `deferred_tools` | [Optional[components.DeferredToolsControl]](../../components/deferredtoolscontrol.mdx) | ➖ | Opt-in versioned router-level deferred-tool protocol. Replay assistant reasoning unchanged on continuation; keep the catalog unchanged. | \{
"profile": "portable",
"protocol": "v1",
"search": \{
"max_results": 5,
"type": "bm25"
},
"validation": "runtime"
} | +| `frequency_penalty` | *OptionalNullable[float]* | ➖ | N/A | | +| `image_config` | Dict[str, [components.ImageConfig](../../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` | List[[components.ResponseIncludesEnum](../../components/responseincludesenum.mdx)] | ➖ | N/A | | +| `input` | [Optional[components.InputsUnion]](../../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[str]* | ➖ | N/A | | +| `max_output_tokens` | *OptionalNullable[int]* | ➖ | N/A | | +| `max_tool_calls` | *OptionalNullable[int]* | ➖ | 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` | Dict[str, *str*] | ➖ | 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` | List[[components.OutputModalityEnum](../../components/outputmodalityenum.mdx)] | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `model` | *Optional[str]* | ➖ | N/A | | +| `models` | List[*str*] | ➖ | N/A | | +| `parallel_tool_calls` | *OptionalNullable[bool]* | ➖ | N/A | | +| `plugins` | List[[components.ResponsesRequestPlugin](../../components/responsesrequestplugin.mdx)] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `presence_penalty` | *OptionalNullable[float]* | ➖ | N/A | | +| `previous_response_id` | *Optional[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[components.StoredPromptTemplate]](../../components/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt_cache_key` | *OptionalNullable[str]* | ➖ | N/A | | +| `prompt_cache_options` | [OptionalNullable[components.PromptCacheOptions]](../../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[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../../components/reasoningconfig.mdx) | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `safety_identifier` | *OptionalNullable[str]* | ➖ | 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 | +| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../../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. | | +| `session_id` | *Optional[str]* | ➖ | 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_server_tools_when` | List[[components.StopServerToolsWhenCondition](../../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` | *Optional[bool]* | ➖ | N/A | | +| `temperature` | *OptionalNullable[float]* | ➖ | N/A | | +| `text` | [Optional[components.TextExtendedConfig]](../../components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../../components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | +| `tools` | List[[components.ResponsesRequestToolUnion](../../components/responsesrequesttoolunion.mdx)] | ➖ | N/A | | +| `top_k` | *Optional[int]* | ➖ | N/A | | +| `top_logprobs` | *OptionalNullable[int]* | ➖ | N/A | | +| `top_p` | *OptionalNullable[float]* | ➖ | N/A | | +| `trace` | [Optional[components.TraceConfig]](../../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[components.OpenAIResponsesTruncation]](../../components/openairesponsestruncation.mdx) | ➖ | N/A | auto | +| `user` | *Optional[str]* | ➖ | 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. | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/scim/README.mdx b/docs/sdks/scim/README.mdx index 240f5da9d..82b0c6ae7 100644 --- a/docs/sdks/scim/README.mdx +++ b/docs/sdks/scim/README.mdx @@ -49,12 +49,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -98,13 +98,13 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `role` | [components.CreateScimGroupMappingRequestRole](../../components/createscimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | -| `scim_group_id` | *str* | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `role` | [components.CreateScimGroupMappingRequestRole](../../components/createscimgroupmappingrequestrole.mdx) | ✅ | N/A | +| `scim_group_id` | *str* | ✅ | N/A | +| `workspace_id` | *str* | ✅ | N/A | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -150,12 +150,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `keep_members` | [operations.KeepMembers](../../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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | N/A | | +| `keep_members` | [operations.KeepMembers](../../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 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -200,11 +200,11 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `id` | *str* | ✅ | N/A | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -248,12 +248,12 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `role` | [components.UpdateScimGroupMappingRequestRole](../../components/updatescimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `id` | *str* | ✅ | N/A | +| `role` | [components.UpdateScimGroupMappingRequestRole](../../components/updatescimgroupmappingrequestrole.mdx) | ✅ | N/A | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -300,14 +300,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `display_name` | *Optional[str]* | :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 | -| `external_id` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `display_name` | *Optional[str]* | ➖ | 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 | +| `external_id` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -351,10 +351,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response @@ -398,11 +398,11 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `id` | *str* | ✅ | N/A | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/stt/README.mdx b/docs/sdks/stt/README.mdx index 50c67920c..ff48aa481 100644 --- a/docs/sdks/stt/README.mdx +++ b/docs/sdks/stt/README.mdx @@ -44,22 +44,22 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `input_audio` | [components.STTInputAudio](../../components/sttinputaudio.mdx) | :heavy_check_mark: | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | -| `model` | *str* | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `diarize` | *Optional[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 | -| `keyterms` | List[*str*] | :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` | *Optional[str]* | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | -| `provider` | [Optional[components.STTRequestProvider]](../../components/sttrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `response_format` | [Optional[components.STTRequestResponseFormat]](../../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 | -| `session_id` | *Optional[str]* | :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` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature for transcription | 0 | -| `timestamp_granularities` | List[[components.STTTimestampGranularity](../../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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `input_audio` | [components.STTInputAudio](../../components/sttinputaudio.mdx) | ✅ | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | +| `model` | *str* | ✅ | STT model identifier | openai/whisper-large-v3 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `diarize` | *Optional[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 | +| `keyterms` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | +| `provider` | [Optional[components.STTRequestProvider]](../../components/sttrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `response_format` | [Optional[components.STTRequestResponseFormat]](../../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 | +| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | Sampling temperature for transcription | 0 | +| `timestamp_granularities` | List[[components.STTTimestampGranularity](../../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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -116,23 +116,23 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `model` | *str* | :heavy_check_mark: | The model to use for transcription. | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `diarize` | *Optional[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` | [Optional[operations.CreateAudioTranscriptionsMultipartFile]](../../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` | List[*str*] | :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` | *Optional[str]* | :heavy_minus_sign: | The language of the input audio (ISO-639-1). | -| `provider` | *Optional[str]* | :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. | -| `response_format` | [Optional[operations.ResponseFormat]](../../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). | -| `session_id` | *Optional[str]* | :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. | -| `source_url` | *Optional[str]* | :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` | *Optional[float]* | :heavy_minus_sign: | The sampling temperature. | -| `timestamp_granularities` | List[[operations.TimestampGranularities](../../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` | *Optional[str]* | :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` | *Optional[str]* | :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. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `model` | *str* | ✅ | The model to use for transcription. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `diarize` | *Optional[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` | [Optional[operations.CreateAudioTranscriptionsMultipartFile]](../../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` | List[*str*] | ➖ | 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` | *Optional[str]* | ➖ | The language of the input audio (ISO-639-1). | +| `provider` | *Optional[str]* | ➖ | 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. | +| `response_format` | [Optional[operations.ResponseFormat]](../../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). | +| `session_id` | *Optional[str]* | ➖ | 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. | +| `source_url` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | The sampling temperature. | +| `timestamp_granularities` | List[[operations.TimestampGranularities](../../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/systemone/README.mdx b/docs/sdks/systemone/README.mdx index fc7688ebe..3fe9cdd04 100644 --- a/docs/sdks/systemone/README.mdx +++ b/docs/sdks/systemone/README.mdx @@ -70,17 +70,17 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `questions` | Dict[str, [components.Questions](../../components/questions.mdx)] | :heavy_check_mark: | N/A | | -| `state` | [components.State](../../components/state.mdx) | :heavy_check_mark: | The content to evaluate: a plain string, or a JSON object or array of related context. | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `session_id` | *Optional[str]* | :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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `model` | *str* | ✅ | N/A | | +| `questions` | Dict[str, [components.Questions](../../components/questions.mdx)] | ✅ | N/A | | +| `state` | [components.State](../../components/state.mdx) | ✅ | The content to evaluate: a plain string, or a JSON object or array of related context. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `provider` | [OptionalNullable[components.ProviderPreferences]](../../components/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `session_id` | *Optional[str]* | ➖ | 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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | N/A | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/tools/README.mdx b/docs/sdks/tools/README.mdx index 1dd30f0b8..8eca33655 100644 --- a/docs/sdks/tools/README.mdx +++ b/docs/sdks/tools/README.mdx @@ -42,14 +42,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `security` | [operations.ListToolsSecurity](../../operations/listtoolssecurity.mdx) | :heavy_check_mark: | N/A | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | -| `api_format` | [Optional[operations.APIFormat]](../../operations/apiformat.mdx) | :heavy_minus_sign: | Only tools usable on this API format | responses | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `security` | [operations.ListToolsSecurity](../../operations/listtoolssecurity.mdx) | ✅ | N/A | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | +| `api_format` | [Optional[operations.APIFormat]](../../operations/apiformat.mdx) | ➖ | Only tools usable on this API format | responses | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -95,12 +95,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `security` | [operations.GetToolSecurity](../../operations/gettoolsecurity.mdx) | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `security` | [operations.GetToolSecurity](../../operations/gettoolsecurity.mdx) | ✅ | N/A | | +| `name` | *str* | ✅ | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/tts/README.mdx b/docs/sdks/tts/README.mdx index 7b3c78a73..c0773b0b0 100644 --- a/docs/sdks/tts/README.mdx +++ b/docs/sdks/tts/README.mdx @@ -40,21 +40,21 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `input` | [components.SpeechInput](../../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 supported by Gemini TTS models and by Fish Audio models other than S1. | Hello world | -| `model` | *str* | :heavy_check_mark: | TTS model identifier | mistralai/voxtral-mini-tts-2603 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `input_references` | List[[components.SpeechInputReference](../../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` | *Optional[str]* | :heavy_minus_sign: | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers. | Speak in a warm and friendly tone. | -| `provider` | [Optional[components.SpeechRequestProvider]](../../components/speechrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `response_format` | [Optional[components.SpeechRequestResponseFormat]](../../components/speechrequestresponseformat.mdx) | :heavy_minus_sign: | Audio output format | pcm | -| `session_id` | *Optional[str]* | :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` | *Optional[float]* | :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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Voice identifier (provider-specific). | en_paul_neutral | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `input` | [components.SpeechInput](../../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 supported by Gemini TTS models and by Fish Audio models other than S1. | Hello world | +| `model` | *str* | ✅ | TTS model identifier | mistralai/voxtral-mini-tts-2603 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `input_references` | List[[components.SpeechInputReference](../../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` | *Optional[str]* | ➖ | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts, Gemini TTS, and Fish Audio models. Ignored by other providers. | Speak in a warm and friendly tone. | +| `provider` | [Optional[components.SpeechRequestProvider]](../../components/speechrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `response_format` | [Optional[components.SpeechRequestResponseFormat]](../../components/speechrequestresponseformat.mdx) | ➖ | Audio output format | pcm | +| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[float]* | ➖ | 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` | [Optional[components.TraceConfig]](../../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` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Voice identifier (provider-specific). | en_paul_neutral | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/vault/README.mdx b/docs/sdks/vault/README.mdx index 8d9386c0a..69833a005 100644 --- a/docs/sdks/vault/README.mdx +++ b/docs/sdks/vault/README.mdx @@ -47,13 +47,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -104,13 +104,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -160,12 +160,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *str* | :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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Errors @@ -544,14 +544,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *str* | :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 | -| `hosts` | List[*str*] | :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` | *str* | :heavy_check_mark: | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `hosts` | List[*str*] | ✅ | 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` | *str* | ✅ | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -936,12 +936,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `intern_id` | *str* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `names` | List[*str*] | :heavy_check_mark: | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `intern_id` | *str* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `names` | List[*str*] | ✅ | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -994,12 +994,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *Optional[int]* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *Optional[int]* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -1049,11 +1049,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :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 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Errors @@ -1410,13 +1410,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :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 | -| `hosts` | List[*str*] | :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` | *str* | :heavy_check_mark: | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `hosts` | List[*str*] | ✅ | 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` | *str* | ✅ | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/videogeneration/README.mdx b/docs/sdks/videogeneration/README.mdx index f317b0a45..df613b8e2 100644 --- a/docs/sdks/videogeneration/README.mdx +++ b/docs/sdks/videogeneration/README.mdx @@ -43,28 +43,28 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `aspect_ratio` | [Optional[components.VideoGenerationRequestAspectRatio]](../../components/videogenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | -| `callback_url` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | -| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | -| `frame_images` | List[[components.FrameImage](../../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. | | -| `generate_audio` | *Optional[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 | -| `input_references` | List[[components.InputReference](../../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. | | -| `previous_job_id` | *Optional[str]* | :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` | *Optional[str]* | :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` | [Optional[components.VideoGenerationRequestProvider]](../../components/videogenerationrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `resolution` | [Optional[components.VideoGenerationRequestResolution]](../../components/videogenerationrequestresolution.mdx) | :heavy_minus_sign: | Resolution of the generated video | 720p | -| `seed` | *Optional[int]* | :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. | | -| `session_id` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | -| `trace` | [Optional[components.TraceConfig]](../../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"
} | -| `upscale_factor` | *Optional[float]* | :heavy_minus_sign: | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | -| `user` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `model` | *str* | ✅ | N/A | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `aspect_ratio` | [Optional[components.VideoGenerationRequestAspectRatio]](../../components/videogenerationrequestaspectratio.mdx) | ➖ | Aspect ratio of the generated video | 16:9 | +| `callback_url` | *Optional[str]* | ➖ | 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` | *Optional[int]* | ➖ | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | +| `duration` | *Optional[int]* | ➖ | Duration of the generated video in seconds | 8 | +| `frame_images` | List[[components.FrameImage](../../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. | | +| `generate_audio` | *Optional[bool]* | ➖ | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | +| `input_references` | List[[components.InputReference](../../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. | | +| `previous_job_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | 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` | [Optional[components.VideoGenerationRequestProvider]](../../components/videogenerationrequestprovider.mdx) | ➖ | Provider-specific passthrough configuration | | +| `resolution` | [Optional[components.VideoGenerationRequestResolution]](../../components/videogenerationrequestresolution.mdx) | ➖ | Resolution of the generated video | 720p | +| `seed` | *Optional[int]* | ➖ | 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. | | +| `session_id` | *Optional[str]* | ➖ | 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` | *Optional[str]* | ➖ | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | +| `trace` | [Optional[components.TraceConfig]](../../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"
} | +| `upscale_factor` | *Optional[float]* | ➖ | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | +| `user` | *Optional[str]* | ➖ | 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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -113,11 +113,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `job_id` | *str* | ✅ | N/A | job-abc123 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -162,12 +162,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `index` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 0 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `job_id` | *str* | ✅ | N/A | job-abc123 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `index` | *OptionalNullable[int]* | ➖ | N/A | 0 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -216,10 +216,10 @@ with OpenRouter( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | ### Response diff --git a/docs/sdks/workspaces/README.mdx b/docs/sdks/workspaces/README.mdx index bf6f0de6a..f45ce4cc5 100644 --- a/docs/sdks/workspaces/README.mdx +++ b/docs/sdks/workspaces/README.mdx @@ -53,12 +53,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -101,22 +101,22 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Name for the new workspace | Production | -| `slug` | *str* | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the workspace | Production environment workspace | -| `disabled_server_tools` | List[[components.CreateWorkspaceRequestDisabledServerTool](../../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"
] | -| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | -| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `name` | *str* | ✅ | Name for the new workspace | Production | +| `slug` | *str* | ✅ | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `default_image_model` | *OptionalNullable[str]* | ➖ | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *OptionalNullable[str]* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *OptionalNullable[str]* | ➖ | Default text model for this workspace | openai/gpt-4o | +| `description` | *OptionalNullable[str]* | ➖ | Description of the workspace | Production environment workspace | +| `disabled_server_tools` | List[[components.CreateWorkspaceRequestDisabledServerTool](../../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"
] | +| `io_logging_api_key_ids` | List[*int*] | ➖ | Optional array of API key IDs to filter I/O logging | null | +| `io_logging_sampling_rate` | *Optional[float]* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | +| `is_data_discount_logging_enabled` | *Optional[bool]* | ➖ | Whether data discount logging is enabled | true | +| `is_observability_broadcast_enabled` | *Optional[bool]* | ➖ | Whether broadcast is enabled | false | +| `is_observability_io_logging_enabled` | *Optional[bool]* | ➖ | Whether private logging is enabled | false | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -161,12 +161,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `confirm_default_workspace_deletion` | *Optional[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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `confirm_default_workspace_deletion` | *Optional[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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -212,11 +212,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -260,23 +260,23 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the workspace | Updated description | -| `disabled_server_tools` | List[[components.UpdateWorkspaceRequestDisabledServerTool](../../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"
] | -| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | -| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the workspace | Updated Workspace | -| `slug` | *Optional[str]* | :heavy_minus_sign: | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `default_image_model` | *OptionalNullable[str]* | ➖ | Default image model for this workspace | openai/dall-e-3 | +| `default_provider_sort` | *OptionalNullable[str]* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `default_text_model` | *OptionalNullable[str]* | ➖ | Default text model for this workspace | openai/gpt-4o | +| `description` | *OptionalNullable[str]* | ➖ | New description for the workspace | Updated description | +| `disabled_server_tools` | List[[components.UpdateWorkspaceRequestDisabledServerTool](../../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"
] | +| `io_logging_api_key_ids` | List[*int*] | ➖ | Optional array of API key IDs to filter I/O logging | null | +| `io_logging_sampling_rate` | *Optional[float]* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | +| `is_data_discount_logging_enabled` | *Optional[bool]* | ➖ | Whether data discount logging is enabled | true | +| `is_observability_broadcast_enabled` | *Optional[bool]* | ➖ | Whether broadcast is enabled | false | +| `is_observability_io_logging_enabled` | *Optional[bool]* | ➖ | Whether private logging is enabled | false | +| `name` | *Optional[str]* | ➖ | New name for the workspace | Updated Workspace | +| `slug` | *Optional[str]* | ➖ | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -324,13 +324,13 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *OptionalNullable[int]* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *Optional[int]* | ➖ | Maximum number of records to return (max 100) | 50 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -378,12 +378,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `user_ids` | List[*str*] | :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"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `user_ids` | List[*str*] | ✅ | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -432,12 +432,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `user_ids` | List[*str*] | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `id` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `user_ids` | List[*str*] | ✅ | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -483,11 +483,11 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -531,12 +531,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -581,12 +581,12 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response @@ -631,14 +631,14 @@ with OpenRouter( | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `workspace_ref` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `limit_usd` | *float* | :heavy_check_mark: | Spending limit in USD. Must be greater than 0. | 100 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `include_byok_in_budgets` | *Optional[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 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `workspace_ref` | *str* | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `limit_usd` | *float* | ✅ | Spending limit in USD. Must be greater than 0. | 100 | +| `http_referer` | *Optional[str]* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `x_open_router_title` | *Optional[str]* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `x_open_router_categories` | *Optional[str]* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `include_byok_in_budgets` | *Optional[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 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.mdx) | ➖ | Configuration to override the default retry behavior of the client. | | ### Response